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

create-device

Description

Creates a new device in a global network. If you specify both a site ID and a location, the location of the site is used for visualization in the Network Manager console.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-device
--global-network-id <value>
[--description <value>]
[--type <value>]
[--vendor <value>]
[--model <value>]
[--serial-number <value>]
[--location <value>]
[--site-id <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--global-network-id (string)

The ID of the global network.

--description (string)

A description of the device.

Length Constraints: Maximum length of 256 characters.

--type (string)

The type of the device.

--vendor (string)

The vendor of the device.

Length Constraints: Maximum length of 128 characters.

--model (string)

The model of the device.

Length Constraints: Maximum length of 128 characters.

--serial-number (string)

The serial number of the device.

Length Constraints: Maximum length of 128 characters.

--location (structure)

The location of the device.

Shorthand Syntax:

Address=string,Latitude=string,Longitude=string

JSON Syntax:

{
  "Address": "string",
  "Latitude": "string",
  "Longitude": "string"
}

--site-id (string)

The ID of the site.

--tags (list)

The tags to apply to the resource during creation.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "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.

Examples

To create a device

The following create-device example creates a device in the specified global network. The device details include a description, the type, vendor, model, and serial number.

aws networkmanager create-device
    --global-network-id global-network-01231231231231231 \
    --description "New York office device" \
    --type "office device" \
    --vendor "anycompany" \
    --model "abcabc" \
    --serial-number "1234" \
    --region us-west-2

Output:

{
    "Device": {
        "DeviceId": "device-07f6fd08867abc123",
        "DeviceArn": "arn:aws:networkmanager::123456789012:device/global-network-01231231231231231/device-07f6fd08867abc123",
        "GlobalNetworkId": "global-network-01231231231231231",
        "Description": "New York office device",
        "Type": "office device",
        "Vendor": "anycompany",
        "Model": "abcabc",
        "SerialNumber": "1234",
        "CreatedAt": 1575554005.0,
        "State": "PENDING"
    }
}

For more information, see Working with Devices in the Transit Gateway Network Manager Guide.

Output

Device -> (structure)

Information about the device.

DeviceId -> (string)

The ID of the device.

DeviceArn -> (string)

The Amazon Resource Name (ARN) of the device.

GlobalNetworkId -> (string)

The ID of the global network.

Description -> (string)

The description of the device.

Type -> (string)

The device type.

Vendor -> (string)

The device vendor.

Model -> (string)

The device model.

SerialNumber -> (string)

The device serial number.

Location -> (structure)

The site location.

Address -> (string)

The physical address.

Latitude -> (string)

The latitude.

Longitude -> (string)

The longitude.

SiteId -> (string)

The site ID.

CreatedAt -> (timestamp)

The date and time that the site was created.

State -> (string)

The device state.

Tags -> (list)

The tags for the device.

(structure)

Describes a tag.

Key -> (string)

The tag key.

Length Constraints: Maximum length of 128 characters.

Value -> (string)

The tag value.

Length Constraints: Maximum length of 256 characters.