Web Authentication

The RUCKUS Web Authentication (Webauth) method provides an ideal port-based authentication alternative to MAC or IEEE 802.1x authentication.

Supported HTTP Operations

The following HTTP operations are supported for the webauth command that comes under VLAN.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-enable
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:webauth-enable": {
        "webauth-enable": true
    }
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-enable
Request body:
 {
    "icx-openconfig-vlan-webauth-aug:webauth-enable": {
        "webauth-enable": true
    }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config
Request body:
   {
    "icx-openconfig-vlan-webauth-aug:webauth-enable": {
        "webauth-enable": true
    }
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-enable
Request body: None    
Response body: None

The following HTTP operations are supported to enable webauth configuration.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/enable
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:enable": true
}

PATCH method

URL: https://<host>restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: {
    "icx-openconfig-vlan-webauth-aug:webauth-config": {
        "enable": true
    }
}

Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: 
{
        "enable": true   
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/enable
Request body: None    
Response body: None

The following HTTP operations are supported for the secure-login command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/secure-login
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:secure-login": true
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: {
    "icx-openconfig-vlan-webauth-aug:webauth-config": {
        "secure-login": true
    }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: 
{  
    "secure-login": true   
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/secure-login
Request body: None    
Response body: None

The following HTTP operations are supported for the auth-mode command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/auth-mode
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:auth-mode": "username-password"
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: {
    "icx-openconfig-vlan-webauth-aug:webauth-config": {
        "auth-mode": "username-password"
    }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: 
{
    "auth-mode": "username-password"
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/auth-mode
Request body: None    
Response body: None

The following HTTP operations are supported for the reauth-time command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/reauth-time
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:reauth-time": 28800
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: {
    "icx-openconfig-vlan-webauth-aug:webauth-config": {
         "reauth-time": 100
    }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: 
{  
    "reauth-time": 100  
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/reauth-time
Request body: None    
Response body: None

The following HTTP operations are supported for the cycle-time command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/cycle-time
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:cycle-time": 600
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: {
    "icx-openconfig-vlan-webauth-aug:webauth-config": {
        "cycle-time":209
    }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: {
   "cycle-time":200 
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/cycle-time
Request body: None    
Response body: None

The following HTTP operations are supported for the attempt-max-num command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/attempt-max-num
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:attempt-max-num": 5
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: {
    "icx-openconfig-vlan-webauth-aug:webauth-config": {
        "attempt-max-num":29
    }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: {    
   "attempt-max-num":9   
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
            webauth-config/attempt-max-num
Request body: None    
Response body: None

The following HTTP operations are supported for the host-max-num command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/host-max-num
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:host-max-num": 0
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: {
    "icx-openconfig-vlan-webauth-aug:webauth-config": {
        "host-max-num":20
    }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: {    
        "host-max-num":209   
}

Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/    
     webauth-config/host-max-num
Request body: None    
Response body: None

The following HTTP operations are supported for the authenticated-mac-age-time command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/authenticated-mac-age-time
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:authenticated-mac-age-time": 3600
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: {
    "icx-openconfig-vlan-webauth-aug:webauth-config": {
        "authenticated-mac-age-time": 108
    }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: {
    "authenticated-mac-age-time": 100   
}

Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/authenticated-mac-age-time
Request body: None    
Response body: None

The following HTTP operations are supported for the webpage custom-label password-label command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-label
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:custom-label": {
        "password-label": "test"
    }
}
PATCH method
URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/webpage
Request body: {
    "webpage":{
    "custom-label":{
        "password-label": "test"
        }
    }
}   
Response body: None
POST method
URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-label
Request body: {
   "password-label": "test"   
}    
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-label/password-label
Request body: None    
Response body: None

The following HTTP operations are supported for the webpage custom-label username-label command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-label
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:custom-label": {
        "username-label": "test"
    }
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/webpage
Request body: {
    "webpage":{
    "custom-label":{
        "username-label": "test"
    }
}
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-label
Request body: {
    
  "username-label": "test"   
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-label/username-label
Request body: None    
Response body: None

The following HTTP operations are supported for the webpage custom-text bottom command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-text
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:custom-text": {
        "bottom": "BOTTOM"
    }
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-text
Request body: {
   "custom-text":{
    "bottom" : "BOTTOM"
   }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-text
Request body: {
       "bottom" : "BOTTOM" 
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-text/bottom
Request body: None    
Response body: None

The following HTTP operations are supported for the webpage custom-text top command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-text
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:custom-text": {
        "top": "TOP"
    }
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-text
Request body: {
    "block":{
         "duration" : 900
    }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-text
Request body: {
   
    "top" : "TOP"
    
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-text/top
Request body: None    
Response body: None

The following HTTP operations are supported for the webpage custom-text title command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-text
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:custom-text": {
        "title": "TITLE"
    }
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-text
Request body: {
   "custom-text":{
    "title" : "TITLE"
   }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-text
Request body: {
   
    "title" : "TITLE"
    
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-text/title
Request body: None    
Response body: None

The following HTTP operations are supported for the webpage custom-text login-button command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-text
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:custom-text": {
        "login-button": "button"
    }
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-text
Request body: {
   "custom-text":{
    "login-button" : "button"
   }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-text
Request body: {
   
    "login-button" : "button"
    
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/custom-text/login-button
Request body: None    
Response body: None

The following HTTP operations are supported for the webpage logo align { left | center | right } command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/logo/align
Request body: None
Response body: {
    "align": "center"
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/logo/align
Request body: {
    "align": "right"
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/logo/align
Request body: {
    "align": "center"
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/logo/align
Request body: None    
Response body: None

The following HTTP operations are supported for the webpage logo copy tftp command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/logo/copy/tftp
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:tftp": {
        "address": "10.136.193.207",
        "file-name": "ruckus_wireless.jpg"
    }
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/logo/copy/tftp
Request body: {   
  "tftp" :{"address" : "10.136.193.207", "file-name" :"ruckus_wireless.jpg"}
} 
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/logo/copy
Request body: {   
  "tftp" :{"address" : "10.136.193.207", "file-name" :"ruckus_wireless.jpg"}                
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/webpage/logo/copy/tftp
Request body: None    
Response body: None

The following HTTP operations are supported for the webpage remove-userid-label command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/500/config/webauth-config/webpage
Request body: None
Response body: {    
   "icx-openconfig-vlan-webauth-aug:webpage": 
    {        
    "remove-userid-label": true    
    }
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/500/config/webauth-config/webpage
Request body: {
   "webpage":    
    {        
    "remove-userid-label" : true    
    }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/500/config/webauth-config/webpage
Request body: {    
   "remove-userid-label" : true
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/500/config/
     webauth-config/webpage/remove-userid-label
Request body: None    
Response body: None

The following HTTP operations are supported for the trust-port command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/
     config/webauth-config/trust-port
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:trust-port": {
        "interface": [
            "ethernet 1/1/4",
            "ethernet 1/1/1",
            "lag 100"
        ]
    }
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: {
    "webauth-config":{
    "trust-port":{"interface": "ethernet 1/1/5" }
    }
}

Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: 
{
    
    "trust-port":{"interface": "lag 100" }
}
OR
{
    
    "trust-port":{"interface": "ethernet 1/1/1" }
}

Response body: None

DELETE (for interface 1/1/1)

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/trust-port/interface/ethernet 1/1/1
Request body: None    
Response body: None

DELETE (for all trust ports)
URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/trust-port
Request body: None    
Response body: None

The following HTTP operations are supported for the uplink-port command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/uplink-port
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:uplink-port": {
        "interface": "ethernet 1/1/5"
    }
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: {
    "webauth-config":{
     "uplink-port":{"interface": "lag 100" }
    }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body: {
    
    "uplink-port":{"interface": "ethernet 1/1/5" }
    
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/uplink-port
Request body: None    
Response body: None

The following HTTP operations are supported for the block duration command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/block
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:block": {
        "duration": 900
    }
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/block
Request body: {
    "block":{
         "duration" : 900
    }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/block
Request body: {
     "duration" : 10000   
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/block/duration
Request body: None    
Response body: None

The following HTTP operations are supported for the block mac command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/block
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:block": {
        "mac": [
            {
                "address": "aaaa.aaaa.aaaa"
            }
        ]
    }
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/block
Request body: {
    "block":{
        "mac":{
            "address": "bbbb.bbbb.bbbb"
        }
    }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/block
Request body: {  
        "mac":{
            "address": "aaaa.aaaa.aaaa"
        }   
}

Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/block/mac/aaaa.aaaa.aaaa
Request body: None    
Response body: None

The following HTTP operations are supported for the block mac duration command.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/block
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:block": {
        "mac": [
            {
                "address": "aaaa.aaaa.aaaa",
        "duration": 100
            }
        ]
    }
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/block
Request body: {
    "block":{
        "mac":{
            "address": "bbbb.bbbb.bbbb",
        "duration": 100
        }
    }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config/block
Request body: {  
        "mac":{
            "address": "aaaa.aaaa.aaaa",
            "duration": 100
        }   
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/block/mac/aaaa.aaaa.aaaa
Request body: None    
Response body: None

The following HTTP operations are supported for the captive-portal command after enabling the web authentication.

GET method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/captive-portal
Request body: None
Response body: {
    "icx-openconfig-vlan-webauth-aug:captive-portal": {
        "profile": "test"
    }
}

PATCH method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/captive-portal
Request body: {
    "captive-portal":{
        "profile": "test"
    }
}
Response body: None

POST method

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/captive-portal
Request body: {
    
        "profile": "test"
    
}
Response body: None

DELETE

URL: https://<host>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/
     webauth-config/captive-portal
Request body: None    
Response body: None

The following HTTP operations are supported for the radius-server host command. The command is radius-server host auth-port acct-port default key web-auth priority.

GET method

URL: https://<host>/restconf/data/system/aaa/server-groups
Request body: None
Response body: {
    "openconfig-system:server-groups": {
        "server-group": [
            {
                "name": "radius-default-group",
                "config": {
                    "name": "radius-default-group",
                    "type": "openconfig-aaa:RADIUS"
                },
                "state": {},
                "servers": {
                    "server": [
                        {
                            "address": "10.10.10.103",
                            "config": {
                                "name": "radius-default-server",
                                "address": "10.10.10.103"
                            },
                            "state": {},
                            "radius": {
                                "config": {
                                    "auth-port": 1812,
                                    "acct-port": 1812,
                                    "secret-key": "$NlxEblwrc1VA",
                                    "retransmit-attempts": 2,
                                    "icx-openconfig-aaa-aug:web-auth": true,
                                    "icx-openconfig-aaa-aug:priority": 6,
                                    "icx-openconfig-aaa-aug:purpose": "default"
                                },
                                "state": {
                                    "counters": {}
                                }
                            }
                        }
                    ]
                }
            }
        ]
    }
}

PATCH method

URL: https://<host>/restconf/data/system/aaa
Request body: {
        "aaa": {
            "server-groups": {
                "server-group": [
                {
                    "name": "radius-default-group",
                    "config": {
                        "name": "radius-default-group",
                        "type": "RADIUS"
                    },
                    "servers": {
                        "server": [
                        {
                            "address": "10.10.10.103",
                            "config": {
                                "address": "10.10.10.103"
                            },
                           "radius": {
                               "config": {
                                   "auth-port": "1812",
                                   "acct-port": "1812",
                                   "secret-key": "mykeyword",
                                   "web-auth"  : "true",
                                   "priority"  : 6,
                                   "purpose"   : "default"
                               }
                           }
                       }
                       ]
                   }
               }
               ]
           }
       }
}
Response body: None

POST method

URL: https://<host>/restconf/data/system/aaa
Request body: {
     
    "openconfig-system:server-groups": {
        "server-group": [
            {
                "name": "radius-default-group",
                "config": {
                    "name": "radius-default-group",
                    "type": "RADIUS"
                },
                "servers": {
                    "server": [
                        {
                            "address": "10.10.10.101",
                            "config": {
                                "address": "10.10.10.101"
                            },
                            "radius": {
                                "config": {
                                    "auth-port": 1812,
                                    "acct-port": 1813,
                                    "secret-key": "mykeyword",
                                    "web-auth"  : true,
                                    "priority"   : 7,
                                    "purpose": "default" 
                                }
                            }
                        }
                    ]
                }
            }
        ]
    }
}
Response body: None

DELETE

URL: https://<host>/restconf/data/system/aaa/server-groups/server-group/radius-default-group/servers/server/<radius-server-ip>
Request body: None    
Response body: None

Any more details should be added in the below examples?
The following examples show how to create, configure, and delete the captive-portal command.

GET method

URL: https://<host>/restconf/data/captive-portal
Request body: None 
Response body:
{
    "icx-openconfig-vlan-webauth-aug:captive-portal": {
        "config": [
            {
                "name": "test",
                "virtual-ip": "1.2.3.2",
                "virtual-port": 443
            }
        ]
    }
}
Use the following PATCH method to create a captive portal.
URL: https://<host>/restconf/data/captive-portal
Request body: 
{
    "captive-portal":{
         "config":{
            "name":"test"
            
         }
    }
    
}
Use the following PATCH method to configure virtual-ip for captive-portal test.
URL: https://<host>/restconf/data/captive-portal
Request body:
{
    "captive-portal":{
         "config":{
            "name":"test",
            "virtual-ip" : 1.2.3.4
         }
    }
    
}
Use the following PATCH method to configure virtual port for captive-portal test.
URL: https://<host>/restconf/data/captive-portal
Request body:
{
    "captive-portal":{
         "config":{
            "name":"test",
            "virtual-port" :90
         }
    }
}
Use the following PATCH method to configure login page for captive-portal test.
URL: https://<host>/restconf/data/captive-portal
Request body:
{
    "captive-portal":{
         "config":{
            "name":"test",
            "login-page" : "/enroll/ruckus/guestlogin"
         }
    }
    
}
POST method
URL: https://<host>/restconf/data/captive-portal
Request body:
{
             "config":{
            "name":"test",
           "virtual-ip" : "1.2.3.2",
           "virtual-port" :"100",
           "login-page" : "/enroll/ruckus/guestlogin"
         }
    
}
To DELETE the complete profile
URL: https://<host>/restconf/data/captive-portal/config/test
To DELETE the virtual-port
URL: https://<host>/restconf/data/captive-portal/config/test/virtual-port
To DELETE the login page
URL: https://<host>/restconf/data/captive-portal/config/test/login-page
To DELETE the virtual-ip
URL: https://<host>/restconf/data/captive-portal/config/test/virtual-ip
The following example shows how to send multiple configuration settings in a single JSON using webauth configuration. Enable webauth using the PATCH method.
URL: https://<mgmt-ip>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-enable
Request body:
{
    "icx-openconfig-vlan-webauth-aug:webauth-enable": {
        "webauth-enable": true
    }
}
Enter your configuration using the PATCH method.
URL: https://<mgmt-ip>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/100/config/webauth-config
Request body:
{ 
     "webauth-config" :{
        "enable" : false,
        "secure-login" : false,
        "reauth-time" : 3700,
        "cycle-time" : 1100,
        "attempt-max-num" : 7,
        "host-max-num" : 1100,
        "auth-mode" : "username-password",
        "authenticated-mac-age-time": 108,
        "trust-port" : { "interface" :"ethernet 1/1/5" },
        "uplink-port" : {"interface" : "ethernet 1/1/9" },
        "captive-portal":{
            "profile": "test2"
        },
        "block":{
                "duration" : 2000,
                "mac":{
                      "address": "cabb.bbbb.bbbb",
                      "duration": 200
                }
        },
        "webpage" :{
            "custom-label":{
                "username-label": "user-test2",
                "password-label": "password-test2"},
                "logo" :{"align" :"center"
                },
            "custom-text":{
            "bottom" : "bottom-test2",
            "top" : "top-test2",
            "title" : "title-test2",
            "login-button" : "login-button-test2"
            },
            "remove-userid-label":true
        }
    }
}
Verify the configuration using the GET method.
URL: https://<management-ip>/restconf/data/network-instances/network-instance/default-vrf/vlans/vlan/102/config
Response body:
{
    "openconfig-network-instance:config": {
        "vlan-id": 102,
        "icx-openconfig-vlan-aug:management_vlan_default_gateway_container": {},
        "icx-openconfig-vlan-webauth-aug:webauth-enable": {
            "webauth-enable": true
        },
        "icx-openconfig-vlan-webauth-aug:webauth-config": {
            "secure-login": false,
            "trust-port": {
                "interface": [
                    "ethernet 1/1/5"
                ]
            },
            "reauth-time": 3700,
            "cycle-time": 1100,
            "attempt-max-num": 7,
            "block": {
                "duration": 2000,
                "mac": [
                    {
                        "address": "cabb.bbbb.bbbb",
                        "duration": 200
                    }
                ]
            },
            "host-max-num": 1100,
            "authenticated-mac-age-time": 108,
            "captive-portal": {
                "profile": "test2"
            },
            "uplink-port": {
                "interface": "ethernet 1/1/9"
            },
            "webpage": {
                "custom-label": {
                    "password-label": "password-test2",
                    "username-label": "user-test2"
                },
                "custom-text": {
                    "bottom": "bottom-test2",
                    "login-button": "login-button-test2",
                    "title": "title-test2",
                    "top": "top-test2"
                },
                "logo": {
                    "align": "center"
                },
                "remove-userid-label": true
            }
        }
    }
}
Parent topic: Configuring ICX Using the RESTCONF Management Interface