AWS CLI Command Reference

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 ]

describe-device

Description

Returns information about a device.

See also: AWS API Documentation

Synopsis

  describe-device
--device-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--device-id (string)

The device's ID.

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

AlternateSoftwares -> (list)

Beta software releases available for the device.

(structure)

Details about a beta appliance software update.

Version -> (string)

The appliance software version.

Arn -> (string)

The device's ARN.

Brand -> (string)

The device's maker.

CreatedTime -> (timestamp)

When the device was created.

CurrentNetworkingStatus -> (structure)

The device's networking status.

Ethernet0Status -> (structure)

The status of Ethernet port 0.

ConnectionStatus -> (string)

The device's connection status.

HwAddress -> (string)

The device's physical address.

IpAddress -> (string)

The device's IP address.

Ethernet1Status -> (structure)

The status of Ethernet port 1.

ConnectionStatus -> (string)

The device's connection status.

HwAddress -> (string)

The device's physical address.

IpAddress -> (string)

The device's IP address.

LastUpdatedTime -> (timestamp)

When the network status changed.

NtpStatus -> (structure)

Details about a network time protocol (NTP) server connection.

ConnectionStatus -> (string)

The connection's status.

IpAddress -> (string)

The IP address of the server.

NtpServerName -> (string)

The domain name of the server.

CurrentSoftware -> (string)

The device's current software version.

Description -> (string)

The device's description.

DeviceAggregatedStatus -> (string)

A device's aggregated status. Including the device's connection status, provisioning status, and lease status.

DeviceConnectionStatus -> (string)

The device's connection status.

DeviceId -> (string)

The device's ID.

LatestAlternateSoftware -> (string)

The most recent beta software release.

LatestDeviceJob -> (structure)

A device's latest job. Includes the target image version, and the job status.

ImageVersion -> (string)

The target version of the device software.

JobType -> (string)

The job's type.

Status -> (string)

Status of the latest device job.

LatestSoftware -> (string)

The latest software version available for the device.

LeaseExpirationTime -> (timestamp)

The device's lease expiration time.

Name -> (string)

The device's name.

NetworkingConfiguration -> (structure)

The device's networking configuration.

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)

ProvisioningStatus -> (string)

The device's provisioning status.

SerialNumber -> (string)

The device's serial number.

Tags -> (map)

The device's tags.

key -> (string)

value -> (string)

Type -> (string)

The device's type.