Skip to main content

GET – RADIUS Settings

The link to configure RADIUS server from Redfish will come under the ExternalAccountProviders.

Request​

GET https://{{ip}}/redfish/v1/AccountService/ExternalAccountProviders/RADIUS
Content-Type: application/json
Table 1. RADIUS settings properties

Name

Type

Read only

Description

(OData Attributes)  

Refer to OData Support

ServiceAddress

String

False

This property shall contain the IPv4/IPv6 address assigned to the RADIUS server.

ServicePort

String

False

This property shall contain the port on which RADIUS Server is running.
Note
The default port is 1812.

ServiceEnabled

Boolean

False

The value of this property shall be a Boolean indicating whether this service is enabled.

Secret

String

False

This property shall contain the text string that serves as a password between hosts.
Note
This property will be displayed as null always.

ExtendedPrivilege

Object

False

This object shall contain details of the extended privileges allowed for RADIUS users.

Name

Type

Read only

Description

KVMAccess

Boolean

false

The value of this property shall be a Boolean indicating the KVM access to the RADIUS user.

VMediaAccess

Boolean

false

The value of this property shall be a Boolean indicating the VMedia access to the RADIUS user.

AdvancedRADIUSSetting

Object

True

A reference to the resource AdvancedRADIUSSetting.
Note
This property is shown only if the RADIUS server is configured.

Timeout

Integer

True

Default timeout in seconds for RADIUS Authentication.
AccountProviderTypesString

True

This property shall contain the type of external account provider to which this Service connects.

Enum

Description

RedfishService

The external account provider shall be a DMTF Redfish Specification-conformant service. The ServiceAddresses format shall contain a collection of URIs that correspond to a Redfish Account Service

entity.

ActiveDirectoryService

The external account provider shall be a Microsoft Active Directory Technical Specification-conformant service. The ServiceAddresses format shall contain a collection of fully qualified domain names (FQDN) or NetBIOS names that links to the set of domain servers for the Active Directory service.

LDAPService

The external account provider shall be an RFC4511-conformant service. The ServiceAddresses format shall contain a collection of fully qualified domain names (FQDN) that links to the set of LDAP servers for the Service.

OEM

An OEM-specific external authentication or directory service.

Response example​

Error Message

Sample GET Response Body when the RADIUS server is not configured.

{
  "@odata.context":"/redfish/v1/$metadata#ExternalAccountProvider.ExternalAccountProvider",
  "@odata.etag":"\"1584337147\"",
  "@odata.id":"/redfish/v1/AccountService/ExternalAccountProviders/RADIUS",
  "@odata.type":"#ExternalAccountProvider.v1_1_2.ExternalAccountProvider",
  "AuthenticationType":"OEM",
  "Description":"RADIUSserversettings",
  "Id":"RADIUS Server",
  "Name":"RADIUSSettings",
  "Oem":{
    "Ami":{
      "@odata.type":"#AMIExternalAccountProvider.v1_0_0.AMIExternalAccountProvider",
      "ExtendedPrivilege":{
        "KVMAccess":false,
        "VMediaAccess":false
      },
      "Secret":null,
      "ServiceAddress":null,
      "ServicePort":1812,
      "Timeout":null
    }
  },
  "ServiceEnabled":false
}

Error Message 2

Sample GET Response Body when the RADIUS server is configured.

{
  "@odata.context":"/redfish/v1/$metadata#ExternalAccountProvider.ExternalAccountProvider",
  "@odata.etag":"\"1584337147\"",
  "@odata.id":"/redfish/v1/AccountService/ExternalAccountProviders/RADIUS",
  "@odata.type":"#ExternalAccountProvider.v1_1_2.ExternalAccountProvider",
  "AuthenticationType":"OEM",
  "Description":"RADIUS server settings",
  "Id":"RADIUS Server",
  "Name":"RADIUS Settings",
  "Oem":{
    "Ami":{
      "@odata.type":"#AMIExternalAccountProvider.v1_0_0.AMIExternalAccountProvider",
      "AdvancedRADIUSSettings":{
        "@odata.id":"/redfish/v1/AccountService/ExternalAccountProviders/RADIUS/Oem/Ami/AdvancedRADIUSSetting"
      },
      "ExtendedPrivilege":{
        "KVMAccess":true,
        "VMediaAccess":true
      },
      "Secret":null,
      "ServiceAddress":"10.0.122.57",
      "ServicePort":1812,
      "Timeout":3
    }
  },
  "ServiceEnabled":"true"
}