% GRID-LOCATION-UPDATE(1) Cargill, Incorporated | Grid Commands
NAME
grid-location-udpate — Update an existing location
SYNOPSIS
grid location update [FLAGS] [OPTIONS] <{LOCATION_ID|–file FILENAME}>
DESCRIPTION
Update an existing location. This command requires the LOCATION_ID
argument
to specify the ID of the location that is to be updated, and a list of
properties
that will overwrite the properties of the location if all the
properties specified are valid values. The --namespace
option must also be
specified otherwise the namespace used will default to GS1.
Alternatively the --file
option my be used with a YAML file describing
multiple locations to update one or more locations at once.
ARGS
LOCATION_ID
- Unique identifier for location. Conflicts with
--file
FLAGS
-
-h
,--help
- Prints help information
-
-q
,--quiet
- Do not display output
-
-V
,--version
- Prints version information
-v
- Increases verbosity (the opposite of
-q
). Specify multiple times for more output
OPTIONS
-
-f
,--file
- Path to YAML file containing one or more location definitions. If this option
is used,
location_id
,namespace
, andproperty
cannot be specified. -
-k
,--key
- Base name or path to a private signing key file
--namespace
- Location name space (defaults to
GS1
). Conflicts with--file
--property
- Key value pair describing a property of the location
(example: locationName=Foo). Conflicts with
--file
--service-id
- The ID of the service the payload should be sent to; required if running on
Splinter; Format:
<circuit-id>::<service-id>
--url
- URL for the REST API
--wait
- Maximum number of seconds to wait for the batch to be committed.
EXAMPLES
A location can be updated by using the --property
option
$ grid location update \
--location_id 762111177704 \
--namespace GS1 \
--property locationName="Grandma's basement" \
--property locationDescription="My grandma's basement" \
--property locationType=3 \
--property addressLine1="612 Worf ave" \
--property city="St. Paul" \
--property stateOrRegion="MN" \
--property postalCode="55117" \
--property country="United States" \
--property latLong="46729553,-94685898" \
--property contactName="Lorraine"
--property contactEmail="lorraine@fake-email.bike"
--property contactPhone="612-555-1234"
--property contactDate="01/15/2020"
Alternatively, the --file
option can be used to update one or more locations.
Sample YAML file describing a location.
- namespace: GS1
location_id: "762111177704"
properties:
locationName: Grandma's basement
locationDescription: My grandma's basement
locationType: 3
addressLine1: "612 Worf ave"
city: St. Paul
stateOrRegion: MN
postalCode: "55117"
country: United States
latLong: "46729553,-94685898"
contactName: Lorraine
contactEmail: lorraine@fake-email.bike
contactPhone: 612-555-1234
contactDate: 01/15/2020
YAML files can be used to describe locations using the --file
option
$ grid location update --file locations.yaml
ENVIRONMENT VARIABLES
CYLINDER_PATH
- Colon-separated path used to search for the key which will be used to sign transactions
GRID_DAEMON_ENDPOINT
- Specifies a default value for
--url
GRID_DAEMON_KEY
- Specifies a default value for
-k
,--key
GRID_SERVICE_ID
- Specifies a default value for
--service-id
SEE ALSO
| grid-location-create(1)
| grid-location-update(1)
| grid-location-delete(1)
| grid-location-show(1)
| grid-location-list(1)
|
| Grid documentation: https://grid.splinter.dev/docs/0.3/