describe-device¶
Description¶
Returns information about a device.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
describe-device
--device-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--device-id (string)
The device’s ID.
--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
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.
DeviceConnectionStatus -> (string)
The device’s connection status.
DeviceId -> (string)
The device’s ID.
LatestAlternateSoftware -> (string)
The most recent beta software release.
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.