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)

POST http://<mgmt0_IP>/api/mo/sys/callhome/inst.json

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

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <httpProxyEnable>enabled</httpProxyEnable>
      </transport-items>
    </inst-items>
  </callhome-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.

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.

MO	DN
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 Name	Data Type	Description	Values
httpProxyEnable	callhome:Boolean (scalar:Enum8)	Enable HTTP proxy server to send messages	SELECTION: 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)

POST http://<mgmt0_IP>/api/mo/sys/callhome/inst.json

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

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <httpProxyEnable>disabled</httpProxyEnable>
      </transport-items>
    </inst-items>
  </callhome-items>
</System>

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
no transport http proxy enable

Verifying a DME Configuration

MO	DN
callhomeInst	sys/callhome/inst
callhomeTransport	sys/callhome/inst/transport

callhomeTransport Properties

Property Name	Data Type	Description	Values
httpProxyEnable	callhome:Boolean (scalar:Enum8)	Enable HTTP proxy server to send messages	SELECTION: 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

POST http://<mgmt0_IP>/api/mo/sys/callhome/inst.json

{
  "callhomeInst": {
    "children": [
      {
        "callhomeTransport": {
          "attributes": {
            "proxyServer": "HostName",
            "proxyServerPort": "14423"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <proxyServer>HostName</proxyServer>
        <proxyServerPort>14423</proxyServerPort>
      </transport-items>
    </inst-items>
  </callhome-items>
</System>

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
transport http proxy server HostName port 14423

Verifying a DME Configuration

MO	DN
callhomeInst	sys/callhome/inst
callhomeTransport	sys/callhome/inst/transport

callhomeTransport Properties

Property Name	Data Type	Description	Values
proxyServer	callhome:ServerType (string:Basic)	Proxy server name or IP address	MAX SIZE: 255 DEFAULT:
proxyServerPort	scalar: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

POST http://<mgmt0_IP>/api/mo/sys/callhome/inst.json

{
  "callhomeInst": {
    "children": [
      {
        "callhomeTransport": {
          "attributes": {
            "proxyServer": ""
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <proxyServer></proxyServer>
      </transport-items>
    </inst-items>
  </callhome-items>
</System>

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
no transport http proxy server HostName port 14423

Verifying a DME Configuration

MO	DN
callhomeInst	sys/callhome/inst
callhomeTransport	sys/callhome/inst/transport

callhomeTransport Properties

Property Name	Data Type	Description	Values
proxyServer	callhome: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

POST http://<mgmt0_IP>/api/mo/sys/callhome/inst.json

{
  "callhomeInst": {
    "children": [
      {
        "callhomeTransport": {
          "attributes": {
            "httpUseVrf": "SampleString_123"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <httpUseVrf>SampleString_123</httpUseVrf>
      </transport-items>
    </inst-items>
  </callhome-items>
</System>

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
transport http use-vrf SampleString_123

Verifying a DME Configuration

MO	DN
callhomeInst	sys/callhome/inst
callhomeTransport	sys/callhome/inst/transport

callhomeTransport Properties

Property Name	Data Type	Description	Values
httpUseVrf	string: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

POST http://<mgmt0_IP>/api/mo/sys/callhome/inst.json

{
  "callhomeInst": {
    "children": [
      {
        "callhomeTransport": {
          "attributes": {
            "httpUseVrf": "default"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <httpUseVrf>default</httpUseVrf>
      </transport-items>
    </inst-items>
  </callhome-items>
</System>

Note: This example was added in Release 9.3(1).

CLI Commands

callhome
no transport http use-vrf SampleString_123

Verifying a DME Configuration

MO	DN
callhomeInst	sys/callhome/inst
callhomeTransport	sys/callhome/inst/transport

callhomeTransport Properties

Property Name	Data Type	Description	Values
httpUseVrf	string: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