Create Element Radius (v2.0)

POST 
/v2.0/api/tenants/:tenant_id/elements/:element_id/radii

Create the radius configuration of an element.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

element_id stringrequired

The element ID.

application/json

Body

Details of the element radius configuration to be created.

description

The element radius description. Max limit = 256.

id string

The element radius ID.

name stringrequired

The name of the radius server.

override_indicator string[]

The override indicator. Certain configurations can be overridden from RADIUS server using the user policy.

radius_configuration RadiusConfiguration[]
The details of the radius configuration parameters.
Array [
accounting_port int32
The radius configuration accounting port number between 1-65535. Default port is 1813.
authentication_port int32
The radius configuration authentication port number between 1-65535. Default port is 1812.
ip_version int32
The version of the IP.
priority int32
The priority value between 1-255. Lower the priority number, higher is the priority.
retain_shared_secret boolean
If the shared secret is retained. Value = True/False.
server_ip_address string
The valid IP address (IPv4).
shared_secret string
The shared secret, the length of the secret must be between 8-64 characters.
shared_secret_encrypted string
The encrypted shared secret. Value = True.
]
radius_profile_id string

The radius profile ID.

source_interface_id string

The source interface ID of the selected port.

tags string[]

A information field that can be added to identify the radius server. Maximum 10 unique tags of length 128 each are allowed.

Responses

200

Successful Operation

application/json

Schema

Schema

description

The element radius description. Max limit = 256.

id string

The element radius ID.

name stringrequired

The name of the radius server.

override_indicator string[]

The override indicator. Certain configurations can be overridden from RADIUS server using the user policy.

radius_configuration RadiusConfiguration[]
The details of the radius configuration parameters.
Array [
accounting_port int32
The radius configuration accounting port number between 1-65535. Default port is 1813.
authentication_port int32
The radius configuration authentication port number between 1-65535. Default port is 1812.
ip_version int32
The version of the IP.
priority int32
The priority value between 1-255. Lower the priority number, higher is the priority.
retain_shared_secret boolean
If the shared secret is retained. Value = True/False.
server_ip_address string
The valid IP address (IPv4).
shared_secret string
The shared secret, the length of the secret must be between 8-64 characters.
shared_secret_encrypted string
The encrypted shared secret. Value = True.
]
radius_profile_id string

The radius profile ID.

source_interface_id string

The source interface ID of the selected port.

tags string[]

A information field that can be added to identify the radius server. Maximum 10 unique tags of length 128 each are allowed.

Example (from schema)

{
  "id": "string",
  "name": "string",
  "override_indicator": [
    "string"
  ],
  "radius_configuration": [
    {
      "accounting_port": 0,
      "authentication_port": 0,
      "ip_version": 0,
      "priority": 0,
      "retain_shared_secret": true,
      "server_ip_address": "string",
      "shared_secret": "string",
      "shared_secret_encrypted": "string"
    }
  ],
  "radius_profile_id": "string",
  "source_interface_id": "string",
  "tags": [
    "string"
  ]
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "ELEMENT_NOT_FOUND"
      },
      {
        "code": "RADIUS_CONFIG_INVALID_MISSING_RADIUS_CONFIG"
      },
      {
        "code": "RADIUS_CONFIG_INVALID_DUPLICATE_IP_ADDRESS"
      },
      {
        "code": "RADIUS_CONFIG_DUPLICATE_AUTH_ACCT_PORT"
      },
      {
        "code": "RADIUS_CONFIG_SHARED_SECRET_INVALID"
      },
      {
        "code": "RADIUS_CONFIG_INVALID_IP_ADDRESS"
      },
      {
        "code": "RADIUS_CONFIG_MISSING_SERVER_IP_ADDRESS"
      },
      {
        "code": "RADIUS_CONFIG_INVALID_IP_VERSION"
      },
      {
        "code": "RADIUS_SHARED_SECRET_STORAGE_FAILURE"
      },
      {
        "code": "RADIUS_CONFIG_INVALID_SOURCE_INTERFACE_ID"
      },
      {
        "code": "RADIUS_CONFIG_INVALID_PROFILE_ID"
      },
      {
        "code": "INVALID_JSON_EXTRA_ATTRIBUTE"
      },
      {
        "code": "INVALID_JSON_COMMON_ATTR_MISMATCH"
      }
    ]
  }
}

Loading...