[ aws . ds ]

enable-radius

Description

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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  enable-radius
--directory-id <value>
--radius-settings <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--directory-id (string)

The identifier of the directory for which to enable MFA.

--radius-settings (structure)

A RadiusSettings object that contains information about the RADIUS server.

RadiusServers -> (list)

An array of strings that contains the IP addresses of the RADIUS server endpoints, or the IP addresses of your RADIUS server load balancer.

(string)

RadiusPort -> (integer)

The port that your RADIUS server is using for communications. Your on-premises network must allow inbound traffic over this port from the AWS 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 attempted.

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.

Shorthand Syntax:

RadiusServers=string,string,RadiusPort=integer,RadiusTimeout=integer,RadiusRetries=integer,SharedSecret=string,AuthenticationProtocol=string,DisplayLabel=string,UseSameUsername=boolean

JSON Syntax:

{
  "RadiusServers": ["string", ...],
  "RadiusPort": integer,
  "RadiusTimeout": integer,
  "RadiusRetries": integer,
  "SharedSecret": "string",
  "AuthenticationProtocol": "PAP"|"CHAP"|"MS-CHAPv1"|"MS-CHAPv2",
  "DisplayLabel": "string",
  "UseSameUsername": true|false
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

None