upsertRadiusIdentitySourceGroup

The upsertRadiusIdentitySourceGroup operation handles configuration related to RadiusIdentitySourceGroup 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 RadiusIdentitySourceGroup
name True string The name of the RADIUS Identity Source group object
maxFailedAttempts False integer (Optional.) The maximum number of requests sent to a RADIUS server in the group before trying the next server, from 1 to 5. The default is 3.
Field level constraints: must be between 1 and 5 (inclusive). (Note: Additional constraints might exist)
deadTime False integer (Optional.) If a server in the group fails, the depletion reactivation mode reactivates failed servers only after all of the servers in the group are inactive. The dead time is the amount of time, between 0 and 1440 minutes, that elapses between the disabling of the last server in the group and the subsequent re-enabling of all servers. The default is 10 minutes.
Field level constraints: must be between 0 and 1440 (inclusive). (Note: Additional constraints might exist)
description False string Description of the RADIUS Identity Source group object
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
radiusIdentitySources False [object] A comma-delimited list of the names of RadiusIdentitySource objects that are part of this group. A maximum of 15 servers are allowed
Allowed types are: [RadiusIdentitySource]
activeDirectoryRealm False object The Active directory realm which will be used by the radius group for resolving identity
Allowed types are: [ActiveDirectoryRealm]
id False string The ID of the RadiusIdentitySourceGroup
Field level constraints: must match pattern ^((?!;).)*$. (Note: Additional constraints might exist)
type True string radiusidentitysourcegroup

Query Parameters

Parameter Required Type Description
filter False string The criteria used to filter the models you are requesting. It should have the following format: {field}{operator}{value}[;{field}{operator}{value}]. Supported operators are: "!"(not equals), ":"(equals), "~"(similar). Supported fields are: "name". Default filtering for Upsert operation is done by name.

Example

- name: Execute 'upsertRadiusIdentitySourceGroup' operation
  ftd_configuration:
    operation: "upsertRadiusIdentitySourceGroup"
    data:
        version: "{{ version }}"
        name: "{{ name }}"
        maxFailedAttempts: "{{ max_failed_attempts }}"
        deadTime: "{{ dead_time }}"
        description: "{{ description }}"
        radiusIdentitySources: "{{ radius_identity_sources }}"
        activeDirectoryRealm: "{{ active_directory_realm }}"
        id: "{{ id }}"
        type: "{{ type }}"
    query_params:
        filter: "{{ filter }}"