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 . panorama ]

provision-device

Description

Creates a device and returns a configuration archive. The configuration archive is a ZIP file that contains a provisioning certificate that is valid for 5 minutes. Name the configuration archive certificates-omni_*device-name* .zip and transfer it to the device within 5 minutes. Use the included USB storage device and connect it to the USB 3.0 port next to the HDMI output.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  provision-device
[--description <value>]
--name <value>
[--networking-configuration <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--description (string)

A description for the device.

--name (string)

A name for the device.

--networking-configuration (structure)

A networking configuration for the device.

Ethernet0 -> (structure)

Settings for Ethernet port 0.

ConnectionType -> (string)

How the device gets an IP address.

StaticIpConnectionInfo -> (structure)

Network configuration for a static IP connection.

DefaultGateway -> (string)

The connection's default gateway.

Dns -> (list)

The connection's DNS address.

(string)

IpAddress -> (string)

The connection's IP address.

Mask -> (string)

The connection's DNS mask.

Ethernet1 -> (structure)

Settings for Ethernet port 1.

ConnectionType -> (string)

How the device gets an IP address.

StaticIpConnectionInfo -> (structure)

Network configuration for a static IP connection.

DefaultGateway -> (string)

The connection's default gateway.

Dns -> (list)

The connection's DNS address.

(string)

IpAddress -> (string)

The connection's IP address.

Mask -> (string)

The connection's DNS mask.

Ntp -> (structure)

Network time protocol (NTP) server settings.

NtpServers -> (list)

NTP servers to use, in order of preference.

(string)

JSON Syntax:

{
  "Ethernet0": {
    "ConnectionType": "STATIC_IP"|"DHCP",
    "StaticIpConnectionInfo": {
      "DefaultGateway": "string",
      "Dns": ["string", ...],
      "IpAddress": "string",
      "Mask": "string"
    }
  },
  "Ethernet1": {
    "ConnectionType": "STATIC_IP"|"DHCP",
    "StaticIpConnectionInfo": {
      "DefaultGateway": "string",
      "Dns": ["string", ...],
      "IpAddress": "string",
      "Mask": "string"
    }
  },
  "Ntp": {
    "NtpServers": ["string", ...]
  }
}

--tags (map)

Tags for the device.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--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.

Output

Arn -> (string)

The device's ARN.

Certificates -> (blob)

The device's configuration bundle.

DeviceId -> (string)

The device's ID.

IotThingName -> (string)

The device's IoT thing name.

Status -> (string)

The device's status.