Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . alexaforbusiness ]

create-network-profile

Description

Creates a network profile with the specified details.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-network-profile
--network-profile-name <value>
[--description <value>]
--ssid <value>
--security-type <value>
[--eap-method <value>]
[--current-password <value>]
[--next-password <value>]
[--certificate-authority-arn <value>]
[--trust-anchors <value>]
[--client-request-token <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--network-profile-name (string)

The name of the network profile associated with a device.

--description (string)

Detailed information about a device's network profile.

--ssid (string)

The SSID of the Wi-Fi network.

--security-type (string)

The security type of the Wi-Fi network. This can be WPA2_ENTERPRISE, WPA2_PSK, WPA_PSK, WEP, or OPEN.

Possible values:

  • OPEN
  • WEP
  • WPA_PSK
  • WPA2_PSK
  • WPA2_ENTERPRISE

--eap-method (string)

The authentication standard that is used in the EAP framework. Currently, EAP_TLS is supported.

Possible values:

  • EAP_TLS

--current-password (string)

The current password of the Wi-Fi network.

--next-password (string)

The next, or subsequent, password of the Wi-Fi network. This password is asynchronously transmitted to the device and is used when the password of the network changes to NextPassword.

--certificate-authority-arn (string)

The ARN of the Private Certificate Authority (PCA) created in AWS Certificate Manager (ACM). This is used to issue certificates to the devices.

--trust-anchors (list)

The root certificates of your authentication server that is installed on your devices and used to trust your authentication server during EAP negotiation.

(string)

Syntax:

"string" "string" ...

--client-request-token (string)

A unique, user-specified identifier for the request that ensures idempotency.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To create a network profile

The following create-network-profile example creates a network profile with the specified details.

aws alexaforbusiness create-network-profile \
    --network-profile-name Network123 \
    --ssid Janenetwork \
    --security-type WPA2_PSK \
    --current-password 12345

Output:

{
    "NetworkProfileArn": "arn:aws:a4b:us-east-1:123456789012:network-profile/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111/a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
}

For more information, see Managing Network Profiles in the Alexa for Business Administration Guide.

Output

NetworkProfileArn -> (string)

The ARN of the network profile associated with a device.