CLI Product Sender

« Back to sending

The Command Line API is used to create new products. Use the --send argument to start the PDL Client in send mode.

These arguments are mandatory.

--source=<source>

This is assigned when you register your KeyPair with the PDL.

--type=<type>

Product type. This is assigned when you register your KeyPair with the PDL.

--code=<code>

A unique identifier for this product. This should only be reused when updating an existing product. Generally a full event id (2 character network code followed by up to 8 character network event code)

These arguments are optional.

--updateTime=<updateTime>

Optional. Default is now. When this version of source+type+code was updated.

--status=<status>

Optional. Default is UPDATE. Product generators may use any status without spaces. However, the status must be used consistently for all products of that type.

--delete

Optional. A synonym for --status=DELETE. This updates the status to delete. Product generators may send content along with a deleted product.

NOTE: ProductDistribution makes no attempt to remove earlier versions of the product, and only attempts to deliver this update.

--property-<name>=<value>

Optional. Product property. Each property may have only one value. Name and value must not contain an equals (=). It is suggested to wrap the full argument in quotes to avoid shell escapes and errors with spaces in property names or values. For example: "--property-my-property=my property value"

--eventtime=<eventtime>

Optional. An ISO 8601 timestamp for when the event with which this product is associated occurred.

Synonym for --property-eventtime=<eventtime>.

--latitude=<latitude>

Optional. Latitude (in decimal degrees) of event with which this product is associated.

Synonym for --property-latitude=<latitude>.

--longitude=<longitude>

Optional. Longitude (in decimal degrees) of event with which this product is associated.

Synonym for --property-longitude=<longitude>.

--eventsource=<eventsource>

Network that generated event with which this product is associated.

Synonym for --property-eventsource=<eventsource>.

--eventsourcecode=<eventsourcecode>

Code assigned by network that generated event with which this product is associated.

Synonym for --property-eventsourcecode=<eventsourcecode>.

--magnitude=<magnitude>

Optional. Magnitude of event with which this product is associated.

Synonym for --property-magnitude=<magnitude>.

--depth=<depth>

Optional. Depth (in kilometers) of event with which this product is associated.

Synonym for --property-depth=<depth>.

--version=<version>

Optional. Product generator version. This is independent of the Product updateTime, which is used by distribution for versioning.

Synonym for --property-version=<version>.

--link-<relation>=<uri>

Optional. Represent a relationship between this product and another product or resource. Each relation may have many uris. <uri> must be a valid URI as defined by RFC2396 or RFC2732.

--content

Optional. Non-file product content is available via standard input.

--contentType=<contentType>

Optional, used with --content. Content mime-type for content read from standard input.

--file=<file>

Optional. <file> is a path to a file that is product content. The file’s name and modification date are preserved. The mime type is inferred from the file extension. The file is added at the root level of the product.

--directory=<directory>

Optional. <directory> is a path to a directory that contains product contents. Any directory hierarchy within <directory> is preserved.

--privateKey=<privateKey>

Optional. Path to a file containing a PKCS#8 encoded private key in PEM or DER format. When present, the key will be used to generate a signature for this product.

May also be specified as a global configuration property privateKey

--signatureVersion=<signatureVersion>

Optional. Default is v2. Version of the signature algorithm to use when signing the product. Supported versions are: v2

May also be specified as a global configuratino property signatureVersion

--configFile=<file>

Optional. Path to a file containing the configuration for your sender. If ommitted, the sender will check the current working directory for a file called “config.ini”.

Last modified: Tue Sep 3 18:12:07 UTC 2024