|
APIs in Category: radius |
API version 1.11 |
radius-reset-stats |
Radius (Remote Authentication Dial In User Service) is a networking protocol that uses access servers to provide centralized management of access to large networks. Using the radius client service in ONTAP, the iSCSI target can leverage the radius server for centralized CHAP secrets management and user authentication using industry standard protocol. The radius APIs provide radius client management from ONTAP. |
| radius-reset-stats | [top] |
Zero radius client counters
Vfiler-enabled Yes
| radius-server-add | [top] |
Add a radius server to the radius client service
Input Name Range Type Description is-default-server boolean
optional
Whether or not to set the server as default server. port integer
optional
The UDP port number of the radius server. The default port number is 1812 if not specified. Range: [1..2^16-1] radius-ip-addr string
The hostname or IP address (in dotted-decimal format) of the radius server to add. (for example, "192.168.11.12").
Errno Description ENOTSTARTED EINVALIDINPUTERROR
Vfiler-enabled Yes
| radius-server-remove | [top] |
Remove a radius server from the radius client service
Input Name Range Type Description port integer
optional
The UDP port number of the radius server. The default port number is 1812 if not specified. Range: [1..2^16-1] radius-ip-addr string
The hostname or IP address (in dotted-decimal format) of the radius server to remove. (for example, "192.168.11.12").
Errno Description ENOTSTARTED EINVALIDINPUTERROR
Vfiler-enabled Yes
| radius-service-start | [top] |
Start radius client service. Service will be avaliable once the call returns with success.
Errno Description EALREADYSTARTED EINTERNALERROR EREVERTINPROGRESS
Vfiler-enabled Yes
| radius-service-status | [top] |
Get status of the radius client service, whether or not it is running.
Output Name Range Type Description is-available boolean
"true" if radius client service is running, "false" otherwise.
Vfiler-enabled Yes
| radius-service-stop | [top] |
Stop radius client service. Service will no longer be available once the call returns with success.
Errno Description ENOTSTARTED EINTERNALERROR
Vfiler-enabled Yes
| radius-show-info | [top] |
Get the information about the radius client service.
Output Name Range Type Description is-available boolean
"true" if radius client service is running, "false" otherwise. radius-server-list-entries radius-server-list-entry-info[]
A list of configured radius servers.
Vfiler-enabled Yes
| radius-stats-list-info | [top] |
Return radius client statistics
Output Name Range Type Description radius-stats radius-stats-info[]
statistics for radius client
Vfiler-enabled Yes
| Element definition: radius-server-list-entry-info | [top] |
Configuration information about a radius server.
Name Range Type Description radius-server-info string
Ordering information of the radius server. radius-server-ip ip-address
The IP address of the radius server. radius-server-port integer
The UDP port number of the radius server.
| Element definition: radius-stats-info | [top] |
Statistics block
Name Range Type Description access-accepted-packets integer
Count of access-accept radius packets Range: [0..2^32-1] access-challenged-packets integer
Count of access-challenge radius packets Range: [0..2^32-1] access-rejected-packets integer
Count of access-reject radius packets Range: [0..2^32-1] authentication-requests integer
Count of radius authentication requests Range: [0..2^32-1] denied-packets integer
Count of denied radius packets Range: [0..2^32-1] late-packets integer
Count of late reply radius packets Range: [0..2^32-1] retransmitted-packets integer
Count of retransmission of access-request packets Range: [0..2^32-1] short-packets integer
Count of short radius packets Range: [0..2^32-1] timed-out-packets integer
Count of timed-out access-request packets Range: [0..2^32-1] unknown-packets integer
Count of unknown radius packets Range: [0..2^32-1] unknown-server-packets integer
Count of radius packets from unknown server Range: [0..2^32-1]
| Element definition: ip-address | [top] |
One ip address, in dotted-decimal format (for example, "192.168.11.12").
[none]