ACOS
  • Start Here
  • How to Use this Reference
  • Resources
  • Operations
  • Example API Configuration
  • Filters
  • Batching Requests
  • Status Codes
ACOS
  • Docs »
  • banner
  • View page source

banner¶

Define a login banner

banner Specification¶

   
Type Configuration Resource
Element Name banner
Element URI /axapi/v3/banner
Element Attributes banner_attributes
Schema banner schema

Operations Allowed:

OperationMethodURIPayload

Create Object

POST

/axapi/v3/banner

banner attributes


POST /axapi/v3/banner
Payload:
{
    "banner": {
        "exec-banner-cfg": {
            "exec": 1
        }
    }
}

Get Object

GET

/axapi/v3/banner

banner attributes


GET /axapi/v3/banner
Reponse:
{
    "banner": {
        "exec-banner-cfg": {
            "exec": 1
        }, 
        "login-banner-cfg": {
            "login": 0
        }, 
        "uuid": "1f9fe786-5df4-11d9-abbd-001fa00680a0", 
        "a10-url": "/axapi/v3/banner"
    }
}

Modify Object

POST

/axapi/v3/banner

banner attributes

Replace Object

PUT

/axapi/v3/banner

banner attributes


PUT /axapi/v3/banner
Payload:
{
    "banner": {
        "exec-banner-cfg": {
            "exec": 0
        }
    }
}

Delete Object

DELETE

/axapi/v3/banner

banner attributes


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  
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 to indicate n

Type: string

Format: string-rlx

Maximum Length: 2048 characters

Maximum Length: 1 characters

login-banner-cfg¶

Specification  
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


© Copyright 2014-2019, a10

Built with Sphinx using a theme provided by Read the Docs.