describe-device¶
Synopsis¶
describe-device
--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¶
--device-id (string) [required]
The device’s ID.
Constraints:
- min:
1- max:
255- pattern:
^[a-zA-Z0-9\-\_]+$
--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--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¶
AlternateSoftwares -> (list)
Beta software releases available for the device.
(structure)
Details about a beta appliance software update.
Version -> (string)
The appliance software version.
Constraints:
- min:
1- max:
255
Arn -> (string)
The device’s ARN.
Constraints:
- min:
1- max:
255
Brand -> (string)
The device’s maker.
Possible values:
AWS_PANORAMALENOVO
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.
Possible values:
CONNECTEDNOT_CONNECTEDCONNECTINGHwAddress -> (string)
The device’s physical address.
Constraints:
- min:
1- max:
255IpAddress -> (string)
The device’s IP address.
Constraints:
- min:
1- max:
255- pattern:
^((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d))(:(6553[0-5]|655[0-2]\d|65[0-4]\d{2}|6[0-4]\d{3}|[1-5]\d{4}|[1-9]\d{0,3}))?$Ethernet1Status -> (structure)
The status of Ethernet port 1.
ConnectionStatus -> (string)
The device’s connection status.
Possible values:
CONNECTEDNOT_CONNECTEDCONNECTINGHwAddress -> (string)
The device’s physical address.
Constraints:
- min:
1- max:
255IpAddress -> (string)
The device’s IP address.
Constraints:
- min:
1- max:
255- pattern:
^((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d))(:(6553[0-5]|655[0-2]\d|65[0-4]\d{2}|6[0-4]\d{3}|[1-5]\d{4}|[1-9]\d{0,3}))?$LastUpdatedTime -> (timestamp)
When the network status changed.NtpStatus -> (structure)
Details about a network time protocol (NTP) server connection.
ConnectionStatus -> (string)
The connection’s status.
Possible values:
CONNECTEDNOT_CONNECTEDCONNECTINGIpAddress -> (string)
The IP address of the server.
Constraints:
- min:
1- max:
255- pattern:
^((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d))(:(6553[0-5]|655[0-2]\d|65[0-4]\d{2}|6[0-4]\d{3}|[1-5]\d{4}|[1-9]\d{0,3}))?$NtpServerName -> (string)
The domain name of the server.
Constraints:
- min:
1- max:
255
CurrentSoftware -> (string)
The device’s current software version.
Constraints:
- min:
1- max:
255
Description -> (string)
The device’s description.
Constraints:
- min:
0- max:
255- pattern:
^.*$
DeviceAggregatedStatus -> (string)
A device’s aggregated status. Including the device’s connection status, provisioning status, and lease status.
Possible values:
ERRORAWAITING_PROVISIONINGPENDINGFAILEDDELETINGONLINEOFFLINELEASE_EXPIREDUPDATE_NEEDEDREBOOTING
DeviceConnectionStatus -> (string)
The device’s connection status.
Possible values:
ONLINEOFFLINEAWAITING_CREDENTIALSNOT_AVAILABLEERROR
DeviceId -> (string)
The device’s ID.
Constraints:
- min:
1- max:
255- pattern:
^[a-zA-Z0-9\-\_]+$
LatestAlternateSoftware -> (string)
The most recent beta software release.
Constraints:
- min:
1- max:
255
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.
Constraints:
- min:
1- max:
255- pattern:
^.+$JobType -> (string)
The job’s type.
Possible values:
OTAREBOOTStatus -> (string)
Status of the latest device job.
Possible values:
PENDINGIN_PROGRESSVERIFYINGREBOOTINGDOWNLOADINGCOMPLETEDFAILED
LatestSoftware -> (string)
The latest software version available for the device.
Constraints:
- min:
1- max:
255
LeaseExpirationTime -> (timestamp)
The device’s lease expiration time.
Name -> (string)
The device’s name.
Constraints:
- min:
1- max:
255- pattern:
^[a-zA-Z0-9\-\_]+$
NetworkingConfiguration -> (structure)
The device’s networking configuration.
Ethernet0 -> (structure)
Settings for Ethernet port 0.
ConnectionType -> (string) [required]
How the device gets an IP address.
Possible values:
STATIC_IPDHCPStaticIpConnectionInfo -> (structure)
Network configuration for a static IP connection.
DefaultGateway -> (string) [required]
The connection’s default gateway.
Constraints:
- min:
1- max:
255- pattern:
^.+$Dns -> (list) [required]
The connection’s DNS address.
(string)
Constraints:
- min:
1- max:
255- pattern:
^.+$IpAddress -> (string) [required]
The connection’s IP address.
Constraints:
- min:
1- max:
255- pattern:
^((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d))(:(6553[0-5]|655[0-2]\d|65[0-4]\d{2}|6[0-4]\d{3}|[1-5]\d{4}|[1-9]\d{0,3}))?$Mask -> (string) [required]
The connection’s DNS mask.
Constraints:
- min:
1- max:
255- pattern:
^.+$Ethernet1 -> (structure)
Settings for Ethernet port 1.
ConnectionType -> (string) [required]
How the device gets an IP address.
Possible values:
STATIC_IPDHCPStaticIpConnectionInfo -> (structure)
Network configuration for a static IP connection.
DefaultGateway -> (string) [required]
The connection’s default gateway.
Constraints:
- min:
1- max:
255- pattern:
^.+$Dns -> (list) [required]
The connection’s DNS address.
(string)
Constraints:
- min:
1- max:
255- pattern:
^.+$IpAddress -> (string) [required]
The connection’s IP address.
Constraints:
- min:
1- max:
255- pattern:
^((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d))(:(6553[0-5]|655[0-2]\d|65[0-4]\d{2}|6[0-4]\d{3}|[1-5]\d{4}|[1-9]\d{0,3}))?$Mask -> (string) [required]
The connection’s DNS mask.
Constraints:
- min:
1- max:
255- pattern:
^.+$Ntp -> (structure)
Network time protocol (NTP) server settings.
NtpServers -> (list) [required]
NTP servers to use, in order of preference.
Constraints:
- min:
0- max:
5(string)
Constraints:
- min:
1- max:
255- pattern:
(^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$)|(^((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d))(:(6553[0-5]|655[0-2]\d|65[0-4]\d{2}|6[0-4]\d{3}|[1-5]\d{4}|[1-9]\d{0,3}))?$)
ProvisioningStatus -> (string)
The device’s provisioning status.
Possible values:
AWAITING_PROVISIONINGPENDINGSUCCEEDEDFAILEDERRORDELETING
SerialNumber -> (string)
The device’s serial number.
Constraints:
- pattern:
^[0-9]{1,20}$
Tags -> (map)
The device’s tags.
Constraints:
- min:
0- max:
50key -> (string)
Constraints:
- min:
1- max:
128- pattern:
^.+$value -> (string)
Constraints:
- min:
0- max:
256- pattern:
^.*$
Type -> (string)
The device’s type.
Possible values:
PANORAMA_APPLIANCE_DEVELOPER_KITPANORAMA_APPLIANCE