radius-server

Configures, retrieves, and modifies Remote Authentication Dial-In User Service (RADIUS) server.

Resource URIs


URI	Description
<base_URI>/config/running/radius-server	Configures RADIUS server.


GET URIs	Description
<base_URI>/config/running/radius-server	Configures RADIUS server.
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}	Configures the host name of the RADIUS server and specifies a VRF though which to communicate with the RADIUS server.
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/auth-port	Configures UDP port for authentication (default=1812).
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/protocol	Specifies the authentication protocol. Parameters include CHAP, PAP, or PEAP-MSCHAP. The default is CHAP.
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/key	Specifies the text string that is used as the shared secret between the device and the RADIUS server. The default is sharedsecret .
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/encryption-level	Designates the encryption level for the shared secret key operation.
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/retries	Configures the number of attempts allowed to connect to a RADIUS server. The default is 5 attempts.
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/timeout	Configures the time to wait for the RADIUS server to respond, in seconds. The default is 5 seconds.
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/source-interface	Retrieves Source Interface information.
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/source-interface/source-interface-value	Displays Source Interface.


PATCH URIs	Payload	Description
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}	<host><auth-port>{rad-auth-port}</auth-port></host>	Configures the host name of the RADIUS server and specifies a VRF though which to communicate with the RADIUS server.
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}	<host><key>{string}</key></host>	Specifies the text string that is used as the shared secret between the device and the RADIUS server. The default is sharedsecret.
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}	<host><encryption-level>{enumeration}</encryption-level></host>	Designates the encryption level for the shared secret key operation.
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}	<host><retries>{uint32}</retries></host>	Configures the number of attempts allowed to connect to a RADIUS server.
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}	<host><timeout>{uint32}</timeout></host>	Configures the time to wait for the RADIUS server to respond, in seconds.
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/source-interface	<source-interface><source-interface-name>{track-iftype}</source-interface-name><source-interface-value>{track-ifname}</source-interface-value></source-interface>	Sets source-interface for the RADIUS packets.


PUT URIs	Payload	Description
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/auth-port	<auth-port>{rad-auth-port}</auth-port>	Configures UDP port for authentication (default=1812).
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/key	<key>{string}</key>	Specifies the text string that is used as the shared secret between the device and the RADIUS server. The default is sharedsecret.
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/encryption-level	<encryption-level>{enumeration}</encryption-level>	Designates the encryption level for the shared secret key operation.
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/retries	<retries>{uint32}</retries>	Configures the number of attempts allowed to connect to a RADIUS server.
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/timeout	<timeout>{uint32}</timeout>	Configures the time to wait for the RADIUS server to respond, in seconds.
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/source-interface	<source-interface><source-interface-name>{track-iftype}</source-interface-name><source-interface-value>{track-ifname}</source-interface-value></source-interface>	Sets source-interface for the RADIUS packets.


DELETE URIs
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/auth-port
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/protocol
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/key
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/encryption-level
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/retries
<base_URI>/config/running/radius-server/host/{hostname},{use-vrf}/timeout
<base_URI>///running/radius-server/host/{hostname},{use-vrf}/source-interface

Parameters

auth-port: Specifies the UDP port for authentication (default=1812).

key: Specifies the text string that is used as the shared secret between the device and the RADIUS server. The default is sharedsecret.

encryption-level: Designates the encryption level for the shared secret key operation. The valid values are 0 and 7, with 0 being clear text and 7 being the most heavily encrypted. The default value is 7.

auth-port: Specifies the readiness test interval value in seconds. Valid values range from 1 through 65535. The default readiness test interval is 10 seconds.

retries: Specifies the number of attempts allowed to connect to a RADIUS server. The default is 5 attempts.

timeout: Specifies the time to wait for the RADIUS server to respond, in seconds. The default is 5 seconds.

source-interface: Specifies the Source interface to be used. Possible values are Ethernet, Loopback, VE, management.

Usage Guidelines

GET, POST, PUT, PATCH, DELETE, OPTIONS, and HEAD operations are supported.

Examples

URI

The following example uses the GET option to retrieve the configuration details.

http://host:80/rest/config/running/radius-server

None

<radius-server xmlns="urn:brocade.com:mgmt:brocade-aaa" xmlns:y="http://brocade.com/ns/rest" 
y:self="/rest/config/running/radius-server">
  <host y:self="/rest/config/running/radius-server/host/50.50.50.50%2Cdata-vrf-1">
    <hostname>50.50.50.50</hostname>
    <use-vrf>data-vrf-1</use-vrf>
  </host>
  <host y:self="/rest/config/running/radius-server/host/10.20.106.145%2Cdata-vrf">
    <hostname>10.20.106.145</hostname>
    <use-vrf>data-vrf</use-vrf>
  </host>
</radius-server>

URI

The following example uses the PUT option to configure RADIUS server.

http://host:80/rest/config/running/config/running/radius-server/host/10.20.106.145/data-vrf/auth-port

<auth-port>11111</auth-port>

None

URI

The following example uses the DELETE option to remove RADIUS server.

http://host:80/rest/config/running/radius-server/host/10.20.106.145/data-vrf

None