Description

The addRadiusIdentitySource operation handles configuration related to RadiusIdentitySource model. 
This API call is not allowed on the standby unit in an HA pair.

HTTP request

POST /api/fdm/v6/object/radiusidentitysources

Data Parameters

Parameter Required Type Description
name True string The name of the RADIUS Identity Source
description False string An optional description of the RADIUS identity source
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
host True string The name of the RADIUS Identity Source
Field level constraints: cannot be null, length must be between 0 and 128 (inclusive), must match pattern ([0-9a-zA-Z]([0-9a-zA-Z-]{0,62}.)([0-9a-zA-Z-]{1,63}.)*[0-9a-zA-Z]{1,63})|(([0-9a-fA-F]{0,4}:){0,6}(([0-9a-fA-F]{0,4}:[0-9a-fA-F]{0,4})|(((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(.|$)){4}))). (Note: Additional constraints might exist)
timeout False integer The optional length of time (in seconds) that the system waits for a RADIUS identity source to respond. If you do not specify a value, the default is 10 seconds
Field level constraints: must be between 1 and 300 (inclusive). (Note: Additional constraints might exist)
serverAuthenticationPort False integer The optional RADIUS identity source UDP port to be used for authentication of users. The allowed range of ports is 1-65535. If you do not specify a value, the default is port 1812
Field level constraints: must be between 1 and 65535 (inclusive). (Note: Additional constraints might exist)
serverSecretKey False string The shared secret used for secure communications between the system and the RADIUS identity source
capabilities False [object] The capabilities that the identity source has.
useRoutingToSelectInterface False boolean option to decide the interface used to connect to the Radius server. The options are: resolving via route lookup or Manually choosing an interface. The default is using route lookup.
redirectAcl False object The Acl that needed to be applied for dynamic authorization
Allowed types are: [ExtendedAccessList]
interface False object Link to Interface object if useRoutingToSelectInterface is false.
Allowed types are: [EtherChannelInterface, PhysicalInterface, SubInterface, VirtualTunnelInterface, VlanInterface]
type True string radiusidentitysource

Example

curl -X POST \
    --header "Accept: application/json" \
    --header "Authorization: Bearer ${ACCESS_TOKEN}" \
    --header "Content-Type: application/json" \
    -d '{
        "capabilities": [],
        "description": "string",
        "host": "string",
        "id": "string",
        "interface": {
            "id": "string",
            "name": "string",
            "type": "string",
            "version": "string"
        },
        "name": "string",
        "redirectAcl": {
            "id": "string",
            "name": "string",
            "type": "string",
            "version": "string"
        },
        "serverAuthenticationPort": 0,
        "serverSecretKey": "string",
        "timeout": 0,
        "type": "radiusidentitysource",
        "useRoutingToSelectInterface": true,
        "version": "string"
    }' \
    "https://${HOST}:${PORT}/api/fdm/v6/object/radiusidentitysources"
from bravado.requests_client import RequestsClient
from bravado.client import SwaggerClient


def get_client(host, token):
    http_client = RequestsClient()
    http_client.ssl_verify = False
    http_client.set_api_key(
        host,
        "Bearer {}".format(token),
        param_name="Authorization",
        param_in="header"
    )
    return SwaggerClient.from_url(
        "https://{}/apispec/ngfw.json".format(host),
        http_client=http_client,
        config={
            "validate_responses": False,
            "validate_swagger_spec": False
        }
    )


def add_radius_identity_source(client, body):
    return client.RadiusIdentitySource.addRadiusIdentitySource(
        body=body
    ).response().result


if __name__ == "__main__":
    host = "ftd.example.com"
    token = "access_token"
    client = get_client(host, token)

    body = {'capabilities': [],
 'description': 'string',
 'host': 'string',
 'interface': {'id': 'string',
               'name': 'string',
               'type': 'string',
               'version': 'string'},
 'name': 'string',
 'redirectAcl': {'id': 'string',
                 'name': 'string',
                 'type': 'string',
                 'version': 'string'},
 'serverAuthenticationPort': 0,
 'serverSecretKey': 'string',
 'timeout': 0,
 'type': 'radiusidentitysource',
 'useRoutingToSelectInterface': True}

    add_radius_identity_source(client, body)