Cisco Nexus 3000 and 9000 Series NX-API REST SDK User Guide and API Reference, Release 10.5(x)
Latest
Enabling Usage of Proxy Server for Messages Sent Over HTTP(S)
DME
YANG
Copy
POST http://<mgmt0_IP>/api/mo/sys/callhome/inst.json

{
  "callhomeInst": {
    "children": [
      {
        "callhomeTransport": {
          "attributes": {
            "httpProxyEnable": "enabled"
}}}]}}

Response
{
    imdata:[]
}

Copy
<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <httpProxyEnable>enabled</httpProxyEnable>
      </transport-items>
    </inst-items>
  </callhome-items>
</System>

Configuring an HTTP Proxy Server

Enabling Usage of Proxy Server for Messages Sent Over HTTP(S)

Enabling Usage of Proxy Server for Messages Sent Over HTTP(S)

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.

callhome
 transport http proxy enable


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.

MODN
callhomeInstsys/callhome/inst
callhomeTransportsys/callhome/inst/transport


callhomeTransport Properties

The following table contains information about the callhomeTransport 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 NameData TypeDescriptionValues
httpProxyEnablecallhome:Boolean
(scalar:Enum8)		Enable HTTP proxy server to send messagesSELECTION:
0 - disabled
1 - enabled
DEFAULT: disabled


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Disabling Usage of Proxy Server for Messages Sent Over HTTP(S)

Disabling Usage of Proxy Server for Messages Sent Over HTTP(S)

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.

callhome
 no transport http proxy enable


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.

MODN
callhomeInstsys/callhome/inst
callhomeTransportsys/callhome/inst/transport


callhomeTransport Properties

The following table contains information about the callhomeTransport 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 NameData TypeDescriptionValues
httpProxyEnablecallhome:Boolean
(scalar:Enum8)		Enable HTTP proxy server to send messagesSELECTION:
0 - disabled
1 - enabled
DEFAULT: disabled


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the Proxy Server Address and Port

Configuring the Proxy Server Address and Port

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.

callhome
 transport http proxy server HostName port 14423


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.

MODN
callhomeInstsys/callhome/inst
callhomeTransportsys/callhome/inst/transport


callhomeTransport Properties

The following table contains information about the callhomeTransport 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 NameData TypeDescriptionValues
proxyServercallhome:ServerType
(string:Basic)		Proxy server name or IP address
MAX SIZE: 255
DEFAULT:
proxyServerPortscalar:Uint32
Configure proxy server port
RANGE: [1 , 65535]
DEFAULT: 8080


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the Proxy Server Address and Port

Deleting the Proxy Server Address and PortF

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.

callhome
  no transport http proxy server HostName port 14423


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.

MODN
callhomeInst sys/callhome/inst
callhomeTransport sys/callhome/inst/transport


callhomeTransport Properties

The following table contains information about the callhomeTransport 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 NameData TypeDescriptionValues
proxyServercallhome:ServerType
(string:Basic)		Proxy server name or IP address
MAX SIZE: 255
DEFAULT:


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Configuring the VRF Name for the HTTP URL Transport Option

Configuring the VRF Name for the HTTP URL Transport Option

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.

callhome
 transport http use-vrf SampleString_123


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.

MODN
callhomeInstsys/callhome/inst
callhomeTransportsys/callhome/inst/transport


callhomeTransport Properties

The following table contains information about the callhomeTransport 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 NameData TypeDescriptionValues
httpUseVrfstring:Basic
Configure HTTP VRF name
RANGE: [1 , 32]
DEFAULT: default


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Deleting the VRF Name for the HTTP URL Transport Option

Deleting the VRF Name for the HTTP URL Transport Option

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.

callhome
 no transport http use-vrf SampleString_123


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.

MODN
callhomeInstsys/callhome/inst
callhomeTransportsys/callhome/inst/transport


callhomeTransport Properties

The following table contains information about the callhomeTransport 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 NameData TypeDescriptionValues
httpUseVrfstring:Basic
Configure HTTP VRF name
RANGE: [1 , 32]
DEFAULT: default


Related Documentation

For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:

http://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-command-reference-list.html

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:

https://www.cisco.com/c/en/us/support/switches/nexus-9000-series-switches/products-programming-reference-guides-list.html

Next