:doc:`DirectoryService <../../ds>` / Client / enable_radius

*************
enable_radius
*************



.. py:method:: DirectoryService.Client.enable_radius(**kwargs)

  

  Enables multi-factor authentication (MFA) with the Remote Authentication Dial In User Service (RADIUS) server for an AD Connector or Microsoft AD directory.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ds-2015-04-16/EnableRadius>`_  


  **Request Syntax**
  ::

    response = client.enable_radius(
        DirectoryId='string',
        RadiusSettings={
            'RadiusServers': [
                'string',
            ],
            'RadiusServersIpv6': [
                'string',
            ],
            'RadiusPort': 123,
            'RadiusTimeout': 123,
            'RadiusRetries': 123,
            'SharedSecret': 'string',
            'AuthenticationProtocol': 'PAP'|'CHAP'|'MS-CHAPv1'|'MS-CHAPv2',
            'DisplayLabel': 'string',
            'UseSameUsername': True|False
        }
    )
    
  :type DirectoryId: string
  :param DirectoryId: **[REQUIRED]** 

    The identifier of the directory for which to enable MFA.

    

  
  :type RadiusSettings: dict
  :param RadiusSettings: **[REQUIRED]** 

    A  RadiusSettings object that contains information about the RADIUS server.

    

  
    - **RadiusServers** *(list) --* 

      The fully qualified domain name (FQDN) or IP addresses of the RADIUS server endpoints, or the FQDN or IP addresses of your RADIUS server load balancer.

      

    
      - *(string) --* 

      
  
    - **RadiusServersIpv6** *(list) --* 

      The IPv6 addresses of the RADIUS server endpoints or RADIUS server load balancer.

      

    
      - *(string) --* 

      
  
    - **RadiusPort** *(integer) --* 

      The port that your RADIUS server is using for communications. Your self-managed network must allow inbound traffic over this port from the Directory Service servers.

      

    
    - **RadiusTimeout** *(integer) --* 

      The amount of time, in seconds, to wait for the RADIUS server to respond.

      

    
    - **RadiusRetries** *(integer) --* 

      The maximum number of times that communication with the RADIUS server is retried after the initial attempt.

      

    
    - **SharedSecret** *(string) --* 

      Required for enabling RADIUS on the directory.

      

    
    - **AuthenticationProtocol** *(string) --* 

      The protocol specified for your RADIUS endpoints.

      

    
    - **DisplayLabel** *(string) --* 

      Not currently used.

      

    
    - **UseSameUsername** *(boolean) --* 

      Not currently used.

      

    
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 

      Contains the results of the  EnableRadius operation.

      
  
  **Exceptions**
  
  *   :py:class:`DirectoryService.Client.exceptions.InvalidParameterException`

  
  *   :py:class:`DirectoryService.Client.exceptions.EntityAlreadyExistsException`

  
  *   :py:class:`DirectoryService.Client.exceptions.EntityDoesNotExistException`

  
  *   :py:class:`DirectoryService.Client.exceptions.ClientException`

  
  *   :py:class:`DirectoryService.Client.exceptions.ServiceException`

  