[ aws . snow-device-management ]

describe-device

Description

Checks device-specific information, such as the device type, software version, IP addresses, and lock status.

See also: AWS API Documentation

Synopsis

  describe-device
--managed-device-id <value>
[--cli-input-json | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--managed-device-id (string)

The ID of the device that you are checking the information of.

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

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

• yaml

• yaml-stream

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

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64

• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

associatedWithJob -> (string)

The ID of the job used when ordering the device.

deviceCapacities -> (list)

The hardware specifications of the device.

(structure)

The physical capacity of the Amazon Web Services Snow Family device.

available -> (long)

The amount of capacity available for use on the device.

name -> (string)

The name of the type of capacity, such as memory.

total -> (long)

The total capacity on the device.

unit -> (string)

The unit of measure for the type of capacity.

used -> (long)

The amount of capacity used on the device.

deviceState -> (string)

The current state of the device.

deviceType -> (string)

The type of Amazon Web Services Snow Family device.

lastReachedOutAt -> (timestamp)

When the device last contacted the Amazon Web Services Cloud. Indicates that the device is online.

lastUpdatedAt -> (timestamp)

When the device last pushed an update to the Amazon Web Services Cloud. Indicates when the device cache was refreshed.

managedDeviceArn -> (string)

The Amazon Resource Name (ARN) of the device.

managedDeviceId -> (string)

The ID of the device that you checked the information for.

physicalNetworkInterfaces -> (list)

The network interfaces available on the device.

(structure)

The details about the physical network interface for the device.

defaultGateway -> (string)

The default gateway of the device.

ipAddress -> (string)

The IP address of the device.

ipAddressAssignment -> (string)

A value that describes whether the IP address is dynamic or persistent.

macAddress -> (string)

The MAC address of the device.

netmask -> (string)

The netmask used to divide the IP address into subnets.

physicalConnectorType -> (string)

The physical connector type.

physicalNetworkInterfaceId -> (string)

The physical network interface ID.

software -> (structure)

The software installed on the device.

installState -> (string)

The state of the software that is installed or that is being installed on the device.

installedVersion -> (string)

The version of the software currently installed on the device.

installingVersion -> (string)

The version of the software being installed on the device.

tags -> (map)

Optional metadata that you assign to a resource. You can use tags to categorize a resource in different ways, such as by purpose, owner, or environment.

key -> (string)

value -> (string)