Skip to content

db.v1.db#

Collection Note

This module is part of the nokia.eda_core_v1 collection. To install the collection, use:

ansible-galaxy collection install nokia.eda_core_v1
Added in version 1.0.0.

Synopsis#

  • Description will be added soon.

Parameters#

Parameter Defaults / Choices Comments
authToken
str
required
HTTP authentication (Bearer authentication) string in the format of "Bearer TOKEN".
Required unless state is cronly.
baseUrl
str
required
EDA API URL including the schema and port (if non standard for the provided schema). Example - https://try.eda.demo:9443.
Required unless state is cronly.
caPath
str
required
A path to the PEM-encoded CA certificate to use for TLS verification.
Required unless state is cronly.
fields
str
A comma-separated list of table fields to fetch/return. If unspecified, all fields are fetched. If empty, no data for a row will be returned; only the JSON path for the table row.
filter
str
An EQL where expression that will be used to filter the set of table rows returned.
includeKeys
bool
If true/present, the keys of the table are included in the table data.
path
str
required
The path for the table to retrieve from the DB, specified as slash-separated table-name components
state
str
required
Choices: query State of the requested resource object.
tlsSkipVerify
bool
required
A flag to control the TLS verification of the session.
Required unless state is cronly.
updates-only
bool
If true/present, only send updates to the table rows, not the current rows. Only applicable if streaming the results.

Authors#