drpcli catalog items_list¶

drpcli catalog_items list¶

List all catalog_items

Synopsis¶

This will list all catalog_items by default. You can narrow down the items returned using index filters. Use the "indexes" command to get the indexes available for catalog_items.

To filter by indexes, you can use the following stanzas:

index Eq value This will return items Equal to value according to index
index Ne value This will return items Not Equal to value according to index
index Lt value This will return items Less Than value according to index
index Lte value This will return items Less Than Or Equal to value according to index
index Gt value This will return items Greater Than value according to index
index Gte value This will return items Greater Than Or Equal to value according to index
index Re re2 compatible regular expression This will return items in index that match the passed-in regular expression We use the regular expression syntax described at https://github.com/google/re2/wiki/Syntax
index Between lower upper This will return items Greater Than Or Equal to lower and Less Than Or Equal to upper according to index
index Except lower upper This will return items Less Than lower or Greater Than upper according to index
index In comma,separated,list,of,values This will return any items In the set passed for the comma-separated list of values.
index Nin comma,separated,list,of,values This will return any items Not In the set passed for the comma-separated list of values.

By default, the list functionality does NOT aggregate parameters for searching or results. Adding aggregate=true will enable searching of attached profiles for values and returning aggregated parameter data. You can also force expand the parameters too by adding expand=true.

For complex queries, the raw= filter can be used to pass a filter string with template expansion pieces. The raw field is added to other filters provided The result of expansion should be a space separated set of filter functions from above.

An example:

'raw={{ .Param "trigger/runner-target" }} Meta.color=pink'

You can chain any number of filters together, and they will pipeline into each other as appropriate. After the above filters have been applied, you can further tweak how the results are returned using the following meta-filters:

'reverse' to return items in reverse order
'limit' number to only return the first number items
'offset' number to skip number items
'sort' index to sort items according to index

You can use 'filter' to specify a Filter object to use as the basis for this query.

drpcli catalog_items list [filters...] [flags]

Options¶

      --filter string   Named Filter to use for this call
  -h, --help            help for list
      --limit int       Maximum number of items to return (default -1)
      --offset int      Number of items to skip before starting to return data (default -1)

Options inherited from parent commands¶

      --ca-cert string                     CA certificate used to verify the server certs (with the system set)
  -c, --catalog string                     The catalog file to use to get product information (default "https://repo.rackn.io")
      --catalog-path string                The path to where the catalog file exists on the drp server. By default and historically this has been /files/rebar-catalog. For example, if no catalog urls are provided, the complete path will be https://drp-ip:8090/files/rebar-catalog (default "/files/rebar-catalog")
  -S, --catalog-source string              A location from which catalog items can be downloaded. For example, in airgapped mode it would be the local catalog
      --client-cert string                 Client certificate to use for communicating to the server - replaces RS_KEY, RS_TOKEN, RS_USERNAME, RS_PASSWORD
      --client-key string                  Client key to use for communicating to the server - replaces RS_KEY, RS_TOKEN, RS_USERNAME, RS_PASSWORD
  -C, --colors string                      The colors for JSON and Table/Text colorization.  8 values in the for 0=val,val;1=val,val2... (default "0=32;1=33;2=36;3=90;4=34,1;5=35;6=95;7=32;8=92")
  -d, --debug                              Whether the CLI should run in debug mode
  -D, --download-proxy string              HTTP Proxy to use for downloading catalog and content
  -E, --endpoint string                    The Digital Rebar Provision API endpoint to talk to (default "https://127.0.0.1:8092")
  -X, --exit-early                         Cause drpcli to exit if a command results in an object that has errors
      --fetch-catalogs all                 Determines which catalog urls to use to fetch the catalog. If set to all, all the catalog urls defined with catalog_url and catalog_urls as well as the default catalog will be used. If set to server, only the catalog urls defined on the server will be used. If set to cli, then the specific url specified with the -c flag will be used. It defaults to `all`. Allowed values `all, `server`, `cli`. (default "all")
  -f, --force                              When needed, attempt to force the operation - used on some update/patch calls
      --force-new-session                  Should the client always create a new session
  -F, --format string                      The serialization we expect for output.  Can be "json" or "yaml" or "text" or "table" (default "json")
      --http-request-retry-count int       Specifies the number of retries for downloads in case of failure
      --http-request-retry-delay-max int   Specifies the maximum delay (in seconds) between HTTP/HTTPS retry attempts (default 60)
      --ignore-unix-proxy                  Should the client ignore unix proxies
  -N, --no-color                           Whether the CLI should output colorized strings
  -H, --no-header                          Should header be shown in "text" or "table" mode
  -x, --no-token                           Do not use token auth or token cache
  -P, --password string                    password of the Digital Rebar Provision user (default "r0cketsk8ts")
  -p, --platform string                    Platform to filter details by. Defaults to current system. Format: arch/os
  -J, --print-fields string                The fields of the object to display in "text" or "table" mode. Comma separated
  -r, --ref string                         A reference object for update commands that can be a file name, yaml, or json blob
      --server-verify                      Should the client verify the server cert
  -T, --token string                       token of the Digital Rebar Provision access
  -t, --trace string                       The log level API requests should be logged at on the server side
  -Z, --trace-token string                 A token that individual traced requests should report in the server logs
  -j, --truncate-length int                Truncate columns at this length (default 40)
  -u, --url-proxy string                   URL Proxy for passing actions through another DRP
  -U, --username string                    Name of the Digital Rebar Provision user to talk to (default "rocketskates")

drpcli catalog items_list¶