Configuring the MOTD Banner
Configuring the MOTD Banner
POST http://<mgmt0_IP>/api/mo/sys/userext.json
{
"aaaUserEp": {
"children": [
{
"aaaPreLoginBanner": {
"attributes": {
"delimiter": "_",
"message": ""
}}}]}}
{
imdata:[]
}
<System>
<userext-items>
<preloginbanner-items>
<delimiter>_</delimiter>
<message></message>
</preloginbanner-items>
</userext-items>
</System>
Configures the MOTB (message-of-the-day) banner.
Guidelines and Limitations
Environment variables cannot be configured through the API interface.
CLI Command
The CLI command below is the equivalent to the payload example 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 or the YANG tab to view the XML payload.
banner motd __
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.
| MO | DN |
|---|---|
| aaaUserEp | sys/userext |
| aaaPreLoginBanner | sys/userext/preloginbanner |
aaaPreLoginBanner Properties
The following table contains information about the aaaPreLoginBanner properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
| Property Name | Data Type | Description | Values |
|---|---|---|---|
| delimiter | aaa:Delimiter (string:CharBuffer) | Delimiter character | |
| message | aaa:BannerMsg (string:CharBuffer) | A message displayed in the banner. |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
See the NX-API DME Model Reference for detailed information about classes and attributes described in the payload:
https://developer.cisco.com/site/nx-os/docs/nexus-model-reference/
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Configuring the Banner Message
Configuring the Banner Message
POST http://<mgmt0_IP>/api/mo/sys/userext.json
{
"aaaUserEp": {
"children": [
{
"aaaPostLoginBanner": {
"attributes": {
"delimiter": "1",
"message": "23:"
}}}]}}
{
imdata:[]
}
<System>
<userext-items>
<postloginbanner-items>
<delimiter>1</delimiter>
<message>23:</message>
</postloginbanner-items>
</userext-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
banner exec 123:12
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
| MO | DN |
|---|---|
| aaaPostLoginBanner | sys/userext/postloginbanner |
| aaaUserEp | sys/userext |
aaaPostLoginBanner Properties
The following table contains information about the aaaPostLoginBanner properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
| Property Name | Data Type | Description | Values |
|---|---|---|---|
| delimiter | aaa:Delimiter (string:CharBuffer) | Delimiter character | DEFAULT: # |
| message | aaa:BannerMsg (string:CharBuffer) | A message displayed in the banner. | By default, this property is empty |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide:
Deleting the Banner Exec Message
Deleting the Banner Exec Message
POST http://<mgmt0_IP>/api/mo/sys/userext.json
{
"aaaUserEp": {
"children": [
{
"aaaPostLoginBanner": {
"attributes": {
"delimiter": "#",
"message": ""
}}}]}}
{
imdata:[]
}
<System>
<userext-items>
<postloginbanner-items>
<delimiter>#</delimiter>
<message></message>
</postloginbanner-items>
</userext-items>
</System>
Note: This example was added in Release 9.3(1).
CLI Commands
The CLI commands are equivalent to the payload examples displayed in the pane on the right. Click the DME tab in the top-left corner of the right pane to view the JSON payload. Click the YANG tab to view the XML payload.
no banner exec
Verifying a DME Configuration
The following table contains the distinguished name (DN) for each managed object (MO) in the DME payload. Issue a GET request using the DN to verify the configuration was posted or to get information about the configured properties of a particular object.
| MO | DN |
|---|---|
| aaaPostLoginBanner | sys/userext/postloginbanner |
| aaaUserEp | sys/userext |
aaaPostLoginBanner Properties
The following table contains information about the aaaPostLoginBanner properties in the DME payload. For more information about the properties and MOs, see the NX-API DME Model Reference linked in the Related Documentation section below.
| Property Name | Data Type | Description | Values |
|---|---|---|---|
| delimiter | aaa:Delimiter (string:CharBuffer) | Delimiter character | DEFAULT: # |
| message | aaa:BannerMsg (string:CharBuffer) | A message displayed in the banner. | By default, this property is empty |
Related Documentation
For other CLI options, see the Cisco Nexus 9000 Series NX-OS Command Reference:
For detailed information about classes and attributes in the payload, see the NX-API DME Model Reference: https://developer.cisco.com/media/dme/index.html
For information about using the payloads, see the Cisco Nexus 9000 Series NX-OS Programmability Guide: