|
Action |
Method |
Payload Required |
API |
|---|---|---|---|
|
To view the dot1x summary |
GET |
No |
/api/operational/switch/dot1x/summary |
|
To view the dot1x configuration |
GET |
No |
/api/config/switch/dot1x |
Example: GET DOT1x APIs
curl -k -u admin:admin -X GET https://209.165.201.1/api/operational/switch/dot1x/summary
Example: GET DOT1x APIs
curl -k -u admin:admin -X GET https://209.165.201.1/api/config/switch/dot1x
- DOT1x guest-vlan Timeout Value APIs
- DOT1x Default authentication APIs
- DOT1x System Authentication Control APIs
- RADIUS Source Interface Address APIs
DOT1x guest-vlan Timeout Value APIs
|
Action |
Method |
Payload Required |
API |
|---|---|---|---|
|
To enable unauthorized users on the access interface to the guest VLAN |
POST |
Yes |
/api/config/switch/dot1x/guest-vlan |
|
To set the time delay between enabling Dot1X and adding a port to the guest VLAN |
PUT |
Yes |
/api/config/switch/dot1x/guest-vlan/timeout |
|
To restore the default configuration |
DELETE |
No |
/api/config/switch/dot1x/guest-vlan/timeout |
|
To get the VLAN timeout value |
GET |
No |
/api/config/switch/dot1x/guest-vlan/timeout |
Example for DOT1x guest-vlan Timeout Value APIs Payload
<timeout>30</timeout>
|
Property |
Type |
Description |
Mandatory/Default Value |
|---|---|---|---|
|
timeout |
integer |
Specifies the time delay in seconds between enabling dot1X and adding the port to the guest VLAN. (Range: 30–180) |
Yes |
Example: POST DOT1x guest-vlan Timeout Value APIs
curl -k -u admin:admin -d "<timeout>30</timeout>" -X POST https://209.165.201.1/api/config/switch/dot1x/guest-vlan -H "Content-Type: application/vnd.yang.data+xml"
Example: PUT DOT1x guest-vlan Timeout Value APIs
curl -k -u admin:admin -d "<timeout>40</timeout>" -X PUT https://209.165.201.1/api/config/switch/dot1x/guest-vlan/timeout -H "Content-Type: application/vnd.yang.data+xml"
Example: DELETE DOT1x guest-vlan Timeout Value APIs
curl -k -u admin:admin -X DELETE https://209.165.201.1/api/config/switch/dot1x/guest-vlan/timeout
Example: GET DOT1x guest-vlan Timeout Value APIs
curl -k -u admin:admin -X GET https://209.165.201.1/api/config/switch/dot1x/guest-vlan/timeout
DOT1x Default authentication APIs
|
Action |
Method |
Payload Required |
API |
|---|---|---|---|
|
To enable authentication methods on a port |
POST |
Yes |
/api/config/switch/dot1x/authentication |
|
To restore the default configuration |
GET |
No |
/api/config/switch/dot1x/authentication/default |
|
To delete the authentication configuration |
DELETE |
No |
/api/config/switch/dot1x/authentication |
Example for DOT1x Default authentication APIs Payload
<default>radius</default>
Example: POST DOT1x Default authentication APIs
curl -k -u admin:admin -d "<default>radius</default>" -X POST https://209.165.201.1/api/config/switch/dot1x/authentication -H "Content-Type: application/vnd.yang.data+xml"
Example: GET DOT1x Default authentication APIs
curl -k -u admin:admin -X GET https://209.165.201.1/api/config/switch/dot1x/authentication/default
Example: DELETE DOT1x Default authentication APIs
curl -k -u admin:admin -X DELETE https://209.165.201.1/api/config/switch/dot1x/authentication
DOT1x System Authentication Control APIs
|
Action |
Method |
Payload Required |
API |
|---|---|---|---|
|
To enable dot1x globally |
POST |
Yes |
/api/config/switch/dot1x |
|
To get the configuration for system authentication control |
GET |
No |
/api/config/switch/dot1x/system-auth-control |
|
To restore default configuration |
DELETE |
No |
/api/config/switch/dot1x/system-auth-control |
Example for DOT1x System Authentication Control APIs Payload
<system-auth-control></system-auth-control>
Example: POST DOT1x System Authentication Control APIs
curl -k -u admin:admin -d "<system-auth-control></system-auth-control>" -X POST https://209.165.201.1/api/config/switch/dot1x -H "Content-Type: application/vnd.yang.data+xml
Example: GET DOT1x System Authentication Control APIs
curl -k -u admin:admin -X GET https://209.165.201.1/api/config/switch/dot1x/system-auth-control
Example: DELETE DOT1x System Authentication Control APIs
curl -k -u admin:admin -X DELETE https://209.165.201.1/api/config/switch/dot1x/system-auth-control
RADIUS Source Interface Address APIs
|
Action |
Method |
Payload Required |
API |
|---|---|---|---|
|
To enable RADIUS-based VLAN assignment |
POST |
Yes |
/api/config/switch/ip/radius/source-interface |
|
To get the RADIUS-based VLAN configurations |
GET |
No |
/api/config/switch/ip/radius/source-interface/vlan |
|
To replace RADIUS-based VLAN |
PUT |
Yes |
/api/config/switch/ip/radius/source-interface/vlan |
|
To disable RADIUS-based VLAN assignment |
DELETE |
No |
/api/config/switch/ip/radius/source-interface/vlan |
Example for RADIUS Source Interface Address APIs Payload
<vlan>505</vlan>
Example: POST RADIUS Source Interface Address APIs
curl -k -u admin:admin -d "<vlan>505</vlan>" -X POST https://209.165.201.1/api/config/switch/ip/radius/source-interface -H "Content-Type: application/vnd.yang.data+xml"
Example: GET RADIUS Source Interface Address APIs
curl -k -u admin:admin -X GET https://209.165.201.1/api/config/switch/ip/radius/source-interface/vlan
Example: PUT RADIUS Source Interface Address APIs
curl -k -u admin:admin -d "<vlan>506</vlan>" -X PUT https://209.165.201.1/api/config/switch/ip/radius/source-interface/vlan -H "Content-Type: application/vnd.yang.data+xml"
Example: DELETE RADIUS Source Interface Address APIs
curl -k -u admin:admin -X DELETE https://209.165.201.1/api/config/switch/ip/radius/source-interface/vlan