Skip to content
/
Add AAA Server

Switch Service API & Model Documentation (0.3.4)

Overview

Rate Limit

For the Switch REST API the following will be true:

  • Limits are applied to each tenant.
  • A maximum of 20 calls can be made per second.
  • Each second 10 calls will be returned to be used.
Download OpenAPI description
Download PDF
Overview
License

RUCKUS Cloud Privacy Policy

Terms of Service

Languages
Servers
Asian region

https://api.asia.ruckus.cloud/

European region

https://api.eu.ruckus.cloud/

North American region

https://api.ruckus.cloud/

AAA Server

Manage AAA (authentication, authorization, and accounting) Servers.

Operations

Get AAA Server-Setting

Request

Get a switch's authentication, authorization, and accounting server setting.

Security
jwtAuth
Path
venueIdstringrequired
aaaServerIdstringrequired
No request payload

Responses

OK

Body
idstring
namestring
usernamestring
passwordstring
purposestring
Enum"UNSPECIFIED""DEFAULT""AUTHENTICATION_ONLY""AUTHORIZATION_ONLY""ACCOUNTING_ONLY"
levelstring
Enum"UNSPECIFIED""READ_WRITE""PORT_CONFIG""READ_ONLY""LEVEL_NONE"
serverTypestring
Enum"__NULL""RADIUS""TACACS_PLUS""LOCAL""NONE_TYPE"
secretstring
ipstring
acctPortinteger(int32)
authPortinteger(int32)
switchCountInVenueinteger(int32)
syncedPasswordSwitchCountinteger(int32)
Response
{
  "id": "string",
  "name": "string",
  "username": "string",
  "password": "string",
  "purpose": "UNSPECIFIED",
  "level": "UNSPECIFIED",
  "serverType": "__NULL",
  "secret": "string",
  "ip": "string",
  "acctPort": 0,
  "authPort": 0,
  "switchCountInVenue": 0,
  "syncedPasswordSwitchCount": 0
}

Update AAA Server

Request

Update authentication, authorization, and accounting server by id. Use activity API with request id to get the status update.

Security
jwtAuth
Path
venueIdstringrequired
aaaServerIdstringrequired
Body
required
idstring
acctPortinteger(int32)[ 0 .. 65535 ]
authPortinteger(int32)[ 0 .. 65535 ]
ipstring^([1-9]|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])(\.([0...
levelstring
Enum"UNSPECIFIED""READ_WRITE""PORT_CONFIG""READ_ONLY""LEVEL_NONE"
namestring[ 2 .. 64 ] characters
passwordstring[ 8 .. 64 ] characters
encryptedPasswordstring
purposestring
Enum"UNSPECIFIED""DEFAULT""AUTHENTICATION_ONLY""AUTHORIZATION_ONLY""ACCOUNTING_ONLY"
secretstring[ 1 .. 64 ] characters
serverTypestring
Enum"__NULL""RADIUS""TACACS_PLUS""LOCAL""NONE_TYPE"
usernamestring[ 2 .. 48 ] characters
authEnableboolean
{
  "id": "string",
  "acctPort": 65535,
  "authPort": 65535,
  "ip": "string",
  "level": "UNSPECIFIED",
  "name": "string",
  "password": "stringst",
  "encryptedPassword": "string",
  "purpose": "UNSPECIFIED",
  "secret": "string",
  "serverType": "__NULL",
  "username": "string",
  "authEnable": true
}

Responses

OK

Body
idstring
namestring
usernamestring
passwordstring
purposestring
Enum"UNSPECIFIED""DEFAULT""AUTHENTICATION_ONLY""AUTHORIZATION_ONLY""ACCOUNTING_ONLY"
levelstring
Enum"UNSPECIFIED""READ_WRITE""PORT_CONFIG""READ_ONLY""LEVEL_NONE"
serverTypestring
Enum"__NULL""RADIUS""TACACS_PLUS""LOCAL""NONE_TYPE"
secretstring
ipstring
acctPortinteger(int32)
authPortinteger(int32)
switchCountInVenueinteger(int32)
syncedPasswordSwitchCountinteger(int32)
aaaServerViewListArray of objects(AAAServerView)
Response
{
  "id": "string",
  "name": "string",
  "username": "string",
  "password": "string",
  "purpose": "UNSPECIFIED",
  "level": "UNSPECIFIED",
  "serverType": "__NULL",
  "secret": "string",
  "ip": "string",
  "acctPort": 0,
  "authPort": 0,
  "switchCountInVenue": 0,
  "syncedPasswordSwitchCount": 0,
  "aaaServerViewList": [
    {}
  ]
}

Delete AAA Server

Request

Delete authentication, authorization, and accounting server by id.

Security
jwtAuth
Path
venueIdstringrequired
aaaServerIdstringrequired
No request payload

Responses

OK

Body
requestIdstring
responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Add AAA Server

Request

Add authentication, authorization, and accounting server. Use activity API with request id to get the status update.

Security
jwtAuth
Path
venueIdstringrequired
Body
required
idstring
acctPortinteger(int32)[ 0 .. 65535 ]
authPortinteger(int32)[ 0 .. 65535 ]
ipstring^([1-9]|[1-9]\d|1\d\d|2[0-4]\d|25[0-5])(\.([0...
levelstring
Enum"UNSPECIFIED""READ_WRITE""PORT_CONFIG""READ_ONLY""LEVEL_NONE"
namestring[ 2 .. 64 ] characters
passwordstring[ 8 .. 64 ] characters
encryptedPasswordstring
purposestring
Enum"UNSPECIFIED""DEFAULT""AUTHENTICATION_ONLY""AUTHORIZATION_ONLY""ACCOUNTING_ONLY"
secretstring[ 1 .. 64 ] characters
serverTypestring
Enum"__NULL""RADIUS""TACACS_PLUS""LOCAL""NONE_TYPE"
usernamestring[ 2 .. 48 ] characters
authEnableboolean
{
  "id": "string",
  "acctPort": 65535,
  "authPort": 65535,
  "ip": "string",
  "level": "UNSPECIFIED",
  "name": "string",
  "password": "stringst",
  "encryptedPassword": "string",
  "purpose": "UNSPECIFIED",
  "secret": "string",
  "serverType": "__NULL",
  "username": "string",
  "authEnable": true
}

Responses

OK

Body
idstring
namestring
usernamestring
passwordstring
purposestring
Enum"UNSPECIFIED""DEFAULT""AUTHENTICATION_ONLY""AUTHORIZATION_ONLY""ACCOUNTING_ONLY"
levelstring
Enum"UNSPECIFIED""READ_WRITE""PORT_CONFIG""READ_ONLY""LEVEL_NONE"
serverTypestring
Enum"__NULL""RADIUS""TACACS_PLUS""LOCAL""NONE_TYPE"
secretstring
ipstring
acctPortinteger(int32)
authPortinteger(int32)
switchCountInVenueinteger(int32)
syncedPasswordSwitchCountinteger(int32)
aaaServerViewListArray of objects(AAAServerView)
Response
{
  "id": "string",
  "name": "string",
  "username": "string",
  "password": "string",
  "purpose": "UNSPECIFIED",
  "level": "UNSPECIFIED",
  "serverType": "__NULL",
  "secret": "string",
  "ip": "string",
  "acctPort": 0,
  "authPort": 0,
  "switchCountInVenue": 0,
  "syncedPasswordSwitchCount": 0,
  "aaaServerViewList": [
    {}
  ]
}

Delete AAA Servers

Request

Delete multiple authentication, authorization, and accounting servers.

Security
jwtAuth
Path
venueIdstringrequired
Body
requiredArray [
string
]
[
  "string"
]

Responses

No Content

Body
requestIdstring
responseobject(EmptyView)
Response
{
  "requestId": "string",
  "response": {
    "id": "string"
  }
}

Query AAA Servers

Request

List of venue's authentication, authorization, and accounting servers.

Security
jwtAuth
Path
venueIdstringrequired
Body
required
fieldsArray of strings
pageinteger(int32)
pageSizeinteger(int32)
sortFieldstring
sortOrderstring
Enum"ASC""DESC"
serverTypestring
Enum"__NULL""RADIUS""TACACS_PLUS""LOCAL""NONE_TYPE"
{
  "fields": [
    "string"
  ],
  "page": 0,
  "pageSize": 0,
  "sortField": "string",
  "sortOrder": "ASC",
  "serverType": "__NULL"
}

Responses

OK

Body
idstring
dataArray of objects
fieldsArray of strings
pageinteger(int32)
totalCountinteger(int64)
totalPagesinteger(int32)
Response
{
  "id": "string",
  "data": [
    {}
  ],
  "fields": [
    "string"
  ],
  "page": 0,
  "totalCount": 0,
  "totalPages": 0
}

AAA Setting

Manage AAA (authentication, authorization, and accounting) Settings.

Operations

Command-Line Interface Template

Manage command-line interface templates.

Operations

Configuration History

Retrieve configuration history.

Operations

DHCP Server

Manage ICX DHCP servers.

Operations

ICX Switch

Manage ICX Switches.

Operations

Import Switch

Import Switches.

Operations

LAG

Manage LAGs (link aggregation groups).

Operations

Profile

Manage switch profiles.

Operations

Profile Template

Manage switch profile templates.

Operations

Profile VLAN

Manage VLANs (virtual local area networks) of switch profile.

Operations

Switch Access Control List

Manage ACLs (access control lists).

Operations

Switch Configuration Backup

Manage configuration backups.

Operations

Switch Firmware Upgrade

Manage firmware upgrade.

Operations

Switch Ports

Manage Ports.

Operations

Switch Static Routes

Manage static routes.

Operations

Switch VLAN

Manage VLANs (virtual local area networks).

Operations

Switch Virtual Ethernet

Manage VE (virtual ethernet) port settings.

Operations

Venue Switch Setting

Manage a switch's venue-level settings.

Operations

Venue Template AAA Server

Manage Venue Template AAA (authentication, authorization, and accounting) Servers.

Operations

Venue Template AAA Setting

Manage Venue Template AAA (authentication, authorization, and accounting) Settings.

Operations

Venue Template Switch Setting

Manage switch settings of venue template.

Operations

Web Authentication Page Template

Manage web authentication page template.

Operations