Configuring the Email Server

You must configure the SMTP server address for the Smart Call Home functionality to work. You can also configure the from and reply-to email addresses. You can configure up to five SMTP servers for Smart Call Home. The servers are tried based on their priority. The highest priority server is tried first. If the message fails to be sent, the next server in the list is tried until the limit is exhausted. If two servers have equal priority, the one that was configured earlier is tried first.

For more information, see the Cisco Nexus 9000 Series NX-OS System Management Configuration Guide:

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

Configuring an SMTP Server

Configuring an SMTP Server

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

{
  "callhomeTransport": {
    "children": [
      {
        "callhomeEmailServer": {
          "attributes": {
            "emailServer": "1.2.3.4",
            "mailServerPort": "18023",
            "mailServerPriority": "7",
            "mailServerUseVrf": "SampleString_123"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <emailserver-items>
          <EmailServer-list>
            <emailServer>1.2.3.4</emailServer>
            <mailServerPort>18023</mailServerPort>
            <mailServerPriority>7</mailServerPriority>
            <mailServerUseVrf>SampleString_123</mailServerUseVrf>
          </EmailServer-list>
        </emailserver-items>
      </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 email mail-server 1.2.3.4 port 18023 priority 7 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
callhomeEmailServersys/callhome/inst/transport/emailserver-1.2.3.4
callhomeTransportsys/callhome/inst/transport


callhomeEmailServer Properties

The following table contains information about the callhomeEmailServer 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
emailServercallhome:ServerType
(string:Basic)		SMTP server name or IP address
MAX SIZE: 255
DEFAULT:
mailServerPortscalar:Uint32
Configure SMTP server port
RANGE: [1 , 65535]
DEFAULT: 25
mailServerPriorityscalar:Uint32
Configure SMTP server priority
RANGE: [0 , 100]
DEFAULT: 50
mailServerUseVrfstring:Basic
Configure SMTP mail server 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 an SMTP Server

Deleting an SMTP Server

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

{
  "callhomeTransport": {
    "children": [
      {
        "callhomeEmailServer": {
          "attributes": {
            "emailServer": "1.2.3.4",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <emailserver-items>
          <EmailServer-list xc:operation="delete">
            <emailServer>1.2.3.4</emailServer>
          </EmailServer-list>
        </emailserver-items>
      </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
 no transport email mail-server 1.2.3.4 port 18023 priority 7 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
callhomeEmailServersys/callhome/inst/transport/emailserver-1.2.3.4
callhomeTransportsys/callhome/inst/transport


callhomeEmailServer Properties

The following table contains information about the callhomeEmailServer 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
emailServercallhome:ServerType
(string:Basic)		SMTP server name or IP address
MAX SIZE: 255
DEFAULT:
statusmo:ModificationStatus
(scalar:Bitmask32)		Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


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 an SMTP Server (IPv6)

Configuring an SMTP Server (IPv6)

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

{
  "callhomeTransport": {
    "children": [
      {
        "callhomeEmailServer": {
          "attributes": {
            "emailServer": "1:2::3:4",
            "mailServerPort": "18023",
            "mailServerPriority": "7",
            "mailServerUseVrf": "SampleString_123"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <emailserver-items>
          <EmailServer-list>
            <emailServer>1:2::3:4</emailServer>
            <mailServerPort>18023</mailServerPort>
            <mailServerPriority>7</mailServerPriority>
            <mailServerUseVrf>SampleString_123</mailServerUseVrf>
          </EmailServer-list>
        </emailserver-items>
      </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 email mail-server 1:2::3:4 port 18023 priority 7 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
callhomeEmailServersys/callhome/inst/transport/emailserver-1:2::3:4
callhomeTransportsys/callhome/inst/transport


callhomeEmailServer Properties

The following table contains information about the callhomeEmailServer 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
emailServercallhome:ServerType
(string:Basic)		SMTP server name or IP address
MAX SIZE: 255
DEFAULT:
mailServerPortscalar:Uint32
Configure SMTP server port
RANGE: [1 , 65535]
DEFAULT: 25
mailServerPriorityscalar:Uint32
Configure SMTP server priority
RANGE: [0 , 100]
DEFAULT: 50
mailServerUseVrfstring:Basic
Configure SMTP mail server 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 an SMTP Server Configuration (IPv6)

Deleting an SMTP Server (IPv6)

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

{
  "callhomeTransport": {
    "children": [
      {
        "callhomeEmailServer": {
          "attributes": {
            "emailServer": "1:2::3:4",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <emailserver-items>
          <EmailServer-list xc:operation="delete">
            <emailServer>1:2::3:4</emailServer>
          </EmailServer-list>
        </emailserver-items>
      </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
 no transport email mail-server 1:2::3:4 port 18023 priority 7 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
callhomeEmailServersys/callhome/inst/transport/emailserver-1:2::3:4
callhomeTransportsys/callhome/inst/transport


callhomeEmailServer Properties

The following table contains information about the callhomeEmailServer 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
emailServercallhome:ServerType
(string:Basic)		SMTP server name or IP address
MAX SIZE: 255
DEFAULT:
statusmo:ModificationStatus
(scalar:Bitmask32)		Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


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 Email Transport

Configuring the Email Transport

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeTransport": {
          "attributes": {
            "emailFrom": "admin@xyz.com",
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <emailFrom>admin@xyz.com</emailFrom>
      </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 email from admin@xyz.com


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
emailFromcallhome:Email
(address:Email)		Configure from email address
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 Email Transport

Deleting the Email Transport

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

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

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <emailFrom></emailFrom>
      </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
 no transport email from admin@xyz.com


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
emailFromcallhome:Email
(address:Email)		Configure from email address
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

Configuring the Reply-to Email Address

Configuring the Reply-to Email Address

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

{
"callhomeInst": {
    "children": [
      {
        "callhomeTransport": {
          "attributes": {
            "emailFrom": "admin@xyz.com",
            "emailReplyTo": "admin@xyz.com"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <emailReplyTo>admin@xyz.com</emailReplyTo>
      </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 email reply-to admin@xyz.com


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
emailReplyTocallhome:Email
(address:Email)		Configure replyto email address
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 Reply-to Email Address

Deleting the Reply-to Email Address

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

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

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <emailReplyTo></emailReplyTo>
      </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
 no transport email reply-to admin@xyz.com


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
emailReplyTocallhome:Email
(address:Email)		Configure replyto email address
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

Configuring the Email Transport for an SMTP Server

Configuring the Email Transport for an SMTP Server

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

{
  "callhomeTransport": {
    "children": [
      {
        "callhomeEmailServer": {
          "attributes": {
            "emailServer": "1:2::3:4",
            "mailServerPort": "65323",
            "mailServerPriority": "0",
            "mailServerUseVrf": "SampleString_123"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <emailserver-items>
          <EmailServer-list>
            <emailServer>1:2::3:4</emailServer>
            <mailServerPort>65323</mailServerPort>
            <mailServerPriority>0</mailServerPriority>
            <mailServerUseVrf>SampleString_123</mailServerUseVrf>
          </EmailServer-list>
        </emailserver-items>
      </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 email smtp-server 1:2::3:4 port 65323 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
callhomeEmailServersys/callhome/inst/transport/emailserver-1:2::3:4
callhomeTransportsys/callhome/inst/transport


callhomeEmailServer Properties

The following table contains information about the callhomeEmailServer 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
emailServercallhome:ServerType
(string:Basic)		SMTP server name or IP address
MAX SIZE: 255
DEFAULT:
mailServerPortscalar:Uint32
Configure SMTP server port
RANGE: [1 , 65535]
DEFAULT: 25
mailServerPriorityscalar:Uint32
Configure SMTP server priority
RANGE: [0 , 100]
DEFAULT: 50
mailServerUseVrfstring:Basic
Configure SMTP mail server 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 Email Transport for an SMTP Server

Deleting the Email Transport for an SMTP Server

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

{
  "callhomeTransport": {
    "children": [
      {
        "callhomeEmailServer": {
          "attributes": {
            "emailServer": "1:2::3:4",
            "status": "deleted"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <emailserver-items>
          <EmailServer-list nc:operation="delete">
            <emailServer>1:2::3:4</emailServer>
          </EmailServer-list>
        </emailserver-items>
      </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
  no transport email smtp-server 1:2::3:4 port 65323 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
callhomeTransport sys/callhome/inst/transport
callhomeEmailServer sys/callhome/inst/transport/emailserver-1:2::3:4


callhomeEmailServer Properties

The following table contains information about the callhomeEmailServer 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
emailServercallhome:ServerType
(string:Basic)		SMTP server name or IP address
MAX SIZE: 255
DEFAULT:
statusmo:ModificationStatus
(scalar:Bitmask32)		Modification statusSELECTION:
2 - created
4 - modified
8 - deleted
16 - replaced


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 a VRF Name for the Email Transport Configuration

Configuring a VRF Name for the Email Transport Configuration

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

{
  "callhomeTransport": {
    "children": [
      {
        "callhomeEmailServer": {
          "attributes": {
            "emailServer": "1.2.3.4",
            "mailServerPort": "63519",
            "mailServerPriority": "0",
            "mailServerUseVrf": "SampleString_123"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <emailserver-items>
          <EmailServer-list>
            <emailServer>1.2.3.4</emailServer>
            <mailServerPort>63519</mailServerPort>
            <mailServerPriority>0</mailServerPriority>
            <mailServerUseVrf>SampleString_123</mailServerUseVrf>
          </EmailServer-list>
        </emailserver-items>
      </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 email smtp-server 1.2.3.4 port 63519 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
callhomeEmailServer sys/callhome/inst/transport/emailserver-1.2.3.4
callhomeTransport sys/callhome/inst/transport


callhomeEmailServer Properties

The following table contains information about the callhomeEmailServer 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
emailServercallhome:ServerType
(string:Basic)		SMTP server name or IP address
MAX SIZE: 255
DEFAULT:
mailServerPortscalar:Uint32
Configure SMTP server port
RANGE: [1 , 65535]
DEFAULT: 25
mailServerPriorityscalar:Uint32
Configure SMTP server priority
RANGE: [0 , 100]
DEFAULT: 50
mailServerUseVrfstring:Basic
Configure SMTP mail server 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

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 a VRF Name for the Email Transport Configuration (IPv6)

Configuring a VRF Name for the Email Transport Configuration (IPv6)

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

{
  "callhomeTransport": {
    "children": [
      {
        "callhomeEmailServer": {
          "attributes": {
            "emailServer": "1:2::3:4",
            "mailServerPort": "63519",
            "mailServerPriority": "0",
            "mailServerUseVrf": "SampleString_123"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <emailserver-items>
          <EmailServer-list>
            <emailServer>1:2::3:4</emailServer>
            <mailServerPort>63519</mailServerPort>
            <mailServerPriority>0</mailServerPriority>
            <mailServerUseVrf>SampleString_123</mailServerUseVrf>
          </EmailServer-list>
        </emailserver-items>
      </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 email smtp-server 1:2::3:4 port 63519 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
callhomeEmailServer sys/callhome/inst/transport/emailserver-1:2::3:4
callhomeTransport sys/callhome/inst/transport


callhomeEmailServer Properties

The following table contains information about the callhomeEmailServer 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
emailServercallhome:ServerType
(string:Basic)		SMTP server name or IP address
MAX SIZE: 255
DEFAULT:
mailServerPortscalar:Uint32
Configure SMTP server port
RANGE: [1 , 65535]
DEFAULT: 25
mailServerPriorityscalar:Uint32
Configure SMTP server priority
RANGE: [0 , 100]
DEFAULT: 50
mailServerUseVrfstring:Basic
Configure SMTP mail server 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

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 a From Email Address

Configuring a From Email Address

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeTransport": {
          "attributes": {
            "emailFrom": "name@abc.com"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <emailFrom>name@abc.com</emailFrom>
      </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 email from name@abc.com


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
emailFromcallhome:Email
(address:Email)		Configure from email address
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

Deleting a From Email Address

Deleting a From Email Address

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

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

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <emailFrom></emailFrom>
      </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
 no transport email from name@abc.com


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
emailFromcallhome:Email
(address:Email)		Configure from email address
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 a Reply-To Email Address

Configuring a Reply-To Email Address

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

{
  "callhomeInst": {
    "children": [
      {
        "callhomeTransport": {
          "attributes": {
            "emailReplyTo": "name@abc.com"
}}}]}}

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <emailReplyTo>name@abc.com</emailReplyTo>
      </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 email reply-to name@abc.com


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
emailReplyTocallhome:Email
(address:Email)		Configure replyto email address
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

Deleting a Reply-To Email Address

Deleting a Reply-To Email Address

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

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

{
    imdata:[]
}

<System>
  <callhome-items>
    <inst-items>
      <transport-items>
        <emailReplyTo></emailReplyTo>
      </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
 no transport email reply-to name@abc.com


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
emailReplyTocallhome:Email
(address:Email)		Configure replyto email address
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