banner¶
Define a login banner
banner Specification¶
Parameter
Value
Type
Configuration Resource
Element Name
banner
Element URI
/axapi/v3/banner
Element Attributes
banner_attributes
Partition Visibility
shared
Schema
Operations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/banner | ||
POST /axapi/v3/banner
Payload:
{
"banner": {
"exec-banner-cfg": {
"exec": 1
}
}
}
| ||||
Get Object | GET | /axapi/v3/banner | ||
GET /axapi/v3/banner
Reponse:
{
"banner": {
"exec-banner-cfg": {
"exec": 1
},
"login-banner-cfg": {
"login": 0
},
"uuid": "1f0caba8-6597-11f0-b71f-6fe93075fb18",
"a10-url": "/axapi/v3/banner"
}
}
| ||||
Modify Object | POST | /axapi/v3/banner | ||
Replace Object | PUT | /axapi/v3/banner | ||
PUT /axapi/v3/banner
Payload:
{
"banner": {
"exec-banner-cfg": {
"exec": 0
}
}
}
| ||||
Delete Object | DELETE | /axapi/v3/banner | ||
DELETE /axapi/v3/banner
Reponse:
{
"response": {
"status": "OK"
}
}
| ||||
banner attributes¶
exec-banner-cfg
Description: exec-banner-cfg is a JSON Block. Please see below for exec-banner-cfg
Type: Object
login-banner-cfg
Description: login-banner-cfg is a JSON Block. Please see below for login-banner-cfg
Type: Object
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
exec-banner-cfg¶
Specification
Value
Type
object
exec
Description Set EXEC process creation banner
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
exec-banner
Description Banner text, string n is taken as line break of multi-line banner text, use \n for n, 077 for ? and 011 for tab
Type: string
Format: string-rlx
Maximum Length: 2048 characters
Maximum Length: 1 characters
login-banner-cfg¶
Specification
Value
Type
object
login
Description Set login banner
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
login-banner
Description Banner text, string n is taken as line break of multi-line banner text, use \n to indicate n
Type: string
Format: string-rlx
Maximum Length: 2048 characters
Maximum Length: 1 characters