[ aws . networkmanager ]
Updates the details for an existing device. To remove information for any of the parameters, specify an empty string.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
update-device
--global-network-id <value>
--device-id <value>
[--aws-location <value>]
[--description <value>]
[--type <value>]
[--vendor <value>]
[--model <value>]
[--serial-number <value>]
[--location <value>]
[--site-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--global-network-id
(string)
The ID of the global network.
--device-id
(string)
The ID of the device.
--aws-location
(structure)
The AWS location of the device.
Zone -> (string)
The Zone the device is located in. This can be the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.
SubnetArn -> (string)
The Amazon Resource Name (ARN) of the subnet the device is located in.
Shorthand Syntax:
Zone=string,SubnetArn=string
JSON Syntax:
{
"Zone": "string",
"SubnetArn": "string"
}
--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)
Describes a location.
Address -> (string)
The physical address.
Latitude -> (string)
The latitude.
Longitude -> (string)
The longitude.
Shorthand Syntax:
Address=string,Latitude=string,Longitude=string
JSON Syntax:
{
"Address": "string",
"Latitude": "string",
"Longitude": "string"
}
--site-id
(string)
The ID of the site.
--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.
See ‘aws help’ for descriptions of global parameters.
To update a device
The following update-device
example updates device device-07f6fd08867abc123
by specifying a site ID for the device.
aws networkmanager update-device \
--global-network-id global-network-01231231231231231 \
--device-id device-07f6fd08867abc123 \
--site-id site-444555aaabbb11223 \
--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": "NY office device",
"Type": "Office device",
"Vendor": "anycompany",
"Model": "abcabc",
"SerialNumber": "1234",
"SiteId": "site-444555aaabbb11223",
"CreatedAt": 1575554005.0,
"State": "UPDATING"
}
}
For more information, see Working with Devices in the Transit Gateway Network Manager Guide.
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.
AWSLocation -> (structure)
The AWS location of the device.
Zone -> (string)
The Zone the device is located in. This can be the ID of an Availability Zone, Local Zone, Wavelength Zone, or an Outpost.
SubnetArn -> (string)
The Amazon Resource Name (ARN) of the subnet the device is located in.
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.