editRadiusIdentitySource

The editRadiusIdentitySource operation handles configuration related to RadiusIdentitySource model. 

Description

This API call is not allowed on the standby unit in an HA pair.

Data Parameters

Parameter Required Type Description
version False string The version of the RadiusIdentitySource
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 1646
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]
id False string The id of the RadiusIdentitySource
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
interface False object Link to Interface object if useRoutingToSelectInterface is false.
Allowed types are: [SubInterface, PhysicalInterface]
type True string radiusidentitysource

Path Parameters

Parameter Required Type Description
objId True string

Example

- name: Execute 'editRadiusIdentitySource' operation
  ftd_configuration:
    operation: "editRadiusIdentitySource"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        description: "{{ description }}"
        host: "{{ host }}"
        timeout: "{{ timeout }}"
        serverAuthenticationPort: "{{ server_authentication_port }}"
        serverSecretKey: "{{ server_secret_key }}"
        capabilities: "{{ capabilities }}"
        useRoutingToSelectInterface: "{{ use_routing_to_select_interface }}"
        redirectAcl: "{{ redirect_acl }}"
        id: "{{ id }}"
        interface: "{{ interface }}"
        type: "{{ type }}"
    path_params:
        objId: "{{ obj_id }}"