Configuring System Logging (UDP)

Configuring Auth as the Facility to Use When Forwarding to the Server

Configuring Auth as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "auth",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>auth</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility auth

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 Auth as the Facility to Use When Forwarding to the Server

Deleting Auth as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility auth

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 Authpriv as the Facility to Use When Forwarding to the Server

Configuring Authpriv as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "authpriv",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>authpriv</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility authpriv

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 Authpriv as the Facility to Use When Forwarding to the Server

Deleting Authpriv as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility authpriv

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 Cron as the Facility to Use When Forwarding to the Server

Configuring Cron as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "cron",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>cron</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility cron

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 Cron as the Facility to Use When Forwarding to the Server

Deleting Cron as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility cron

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 Daemon as the Facility to Use When Forwarding to the Server

Configuring Daemon as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "daemon",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>daemon</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility daemon

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 Daemon as the Facility to Use When Forwarding to the Server

Deleting Daemon as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility daemon

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 FTP as the Facility to Use When Forwarding to the Server

Configuring FTP as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "ftp",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>ftp</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility ftp

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 FTP as the Facility to Use When Forwarding to the Server

Deleting FTP as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility ftp

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 Kernel as the Facility to Use When Forwarding to the Server

Configuring Kernel as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "kern",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>kern</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility kernel

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 Kernel as the Facility to Use When Forwarding to the Server

Deleting Kernel as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility kernel

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 Local0 as the Facility to Use When Forwarding to the Server

Configuring Local0 as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "local0",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>local0</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility local0

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 Local0 as the Facility to Use When Forwarding to the Server

Deleting Local0 as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility local0

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 Local1 as the Facility to Use When Forwarding to the Server

Configuring Local1 as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "local1",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>local1</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility local1

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 Local1 as the Facility to Use When Forwarding to the Server

Deleting Local1 as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility local1

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 Local2 as the Facility to Use When Forwarding to the Server

Configuring Local2 as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "local2",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>local2</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility local2

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 Local2 as the Facility to Use When Forwarding to the Server

Deleting Local2 as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility local2

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 Local3 as the Facility to Use When Forwarding to the Server

Configuring Local3 as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "local3",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>local3</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility local3

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 Local3 as the Facility to Use When Forwarding to the Server

Deleting Local3 as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility local3

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 Local4 as the Facility to Use When Forwarding to the Server

Configuring Local4 as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "local4",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>local4</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility local4

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 Local4 as the Facility to Use When Forwarding to the Server

Deleting Local4 as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility local4

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 Local5 as the Facility to Use When Forwarding to the Server

Configuring Local5 as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "local5",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>local5</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility local5

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 Local5 as the Facility to Use When Forwarding to the Server

Deleting Local5 as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility local5

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 Local6 as the Facility to Use When Forwarding to the Server

Configuring Local6 as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "local6",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>local6</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility local6

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 Local6 as the Facility to Use When Forwarding to the Server

Deleting Local6 as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility local6

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 Local7 as the Facility to Use When Forwarding to the Server

Configuring Local7 as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "local7",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>local7</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility local7

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 Local7 as the Facility to Use When Forwarding to the Server

Deleting Local7 as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility local7

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 LPR as the Facility to Use When Forwarding to the Server

Configuring LPR as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "lpr",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>lpr</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility lpr

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 LPR as the Facility to Use When Forwarding to the Server

Deleting LPR as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility lpr

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 Mail as the Facility to Use When Forwarding to the Server

Configuring Mail as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "mail",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>mail</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility mail

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 Mail as the Facility to Use When Forwarding to the Server

Deleting Mail as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility mail

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 News as the Facility to Use When Forwarding to the Server

Configuring News as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "news",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>news</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility news

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 News as the Facility to Use When Forwarding to the Server

Deleting News as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility news

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 Syslog as the Facility to Use When Forwarding to the Server

Configuring Syslog as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "syslog",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>syslog</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility syslog

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 Syslog as the Facility to Use When Forwarding to the Server

Deleting Syslog as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility syslog

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 User as the Facility to Use When Forwarding to the Server

Configuring User as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "user",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>user</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility user

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 User as the Facility to Use When Forwarding to the Server

Deleting User as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility user

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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 UUCP as the Facility to Use When Forwarding to the Server

Configuring UUCP as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "forwardingFacility": "uucp",
            "host": "host0",
            "port": "123",
            "severity": "notifications",
            "transport": "udp",
            "vrfName": "VRF_1"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list>
        <host>host0</host>
        <forwardingFacility>uucp</forwardingFacility>
        <port>123</port>
        <severity>notifications</severity>
        <transport>udp</transport>
        <vrfName>VRF_1</vrfName>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

logging server host0 5 port 123 use-vrf VRF_1 facility uucp

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
forwardingFacilitysyslog:Facility
(scalar:Enum16)
The facility to be used to send messages to this destination.SELECTION:
0 - kern
1 - user
2 - mail
3 - daemon
4 - auth
5 - syslog
6 - lpr
7 - news
8 - uucp
9 - cron
10 - authpriv
11 - ftp
16 - local0
17 - local1
18 - local2
19 - local3
20 - local4
21 - local5
22 - local6
23 - local7
DEFAULT: local7
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
portsyslog:SyslogPort
(scalar:Uint32)
The syslog service port of the remote destination.
RANGE: [1 , 65535]
DEFAULT: 514
severitysyslog:Severity
(scalar:Enum8)
The severity of the event, alert, or issue that caused the syslog entry to be generated.SELECTION:
0 - emergencies
1 - alerts
2 - critical
3 - errors
4 - warnings
5 - notifications
6 - information
7 - debugging
DEFAULT: notifications
transportmon:Transport
(scalar:Enum8)
TransportSELECTION:
0 - none
1 - tcp
2 - udp
3 - all
4 - tls
DEFAULT: udp
vrfNamel3:VrfName
(string:Basic)
The vrf that remote host belongs toA sequence of characters


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 UUCP as the Facility to Use When Forwarding to the Server

Deleting UUCP as the Facility to Use When Forwarding to the Server
POST http://<mgmt0_IP>/api/mo/sys/syslog.json
{
  "syslogSyslog": {
    "children": [
      {
        "syslogRemoteDest": {
          "attributes": {
            "host": "host0",
            "status": "deleted"
}}}]}}
{
    imdata:[]
}
<System>
  <syslog-items>
    <rdst-items>
      <RemoteDest-list xc:operation="delete">
        <host>host0</host>
      </RemoteDest-list>
    </rdst-items>
  </syslog-items>
</System>


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.

no logging server host0 5 port 123 use-vrf VRF_1 facility uucp

Note: The property information for this example was added in Release 9.3(3).


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
syslogSyslog sys/syslog
syslogRemoteDest sys/syslog/rdst-{host}


syslogRemoteDest Properties

The following table contains information about the syslogRemoteDest 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
hostaddress:HostNameOrDottedQuad
(string:Basic)
Hostname or IP for export destination
MAX SIZE: 254
statusmo:ModificationStatus
(scalar:Bitmask32)
The upgrade status. This property is for internal use only.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:

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