@dx-do/cli

Command-line execution of DXO2 SaaS operations

Usage

:warning: Using npm install for this package is highly discouraged.

npx @dx-do/cli@<version> <--config=<config-file>> command-group command <parameter>=<value>

Output

ℹ  info      dx-do v5.2.43 on node v22.21.0 on darwin-arm64 via node (ssl: 3.5.4)
⚠  warning   Not loading configuration
✖  error     Usage: dx-do --option[=value]... <command-group> <command> <command-param>=<value>...
ℹ  info      Available command-groups: agent, vertex, auth, dashboard, jsextension, axa, config, channel, alert, nass, alarm, apm-universe, o2-universe, trace, topographer, service, help, graph, metric, metrex, tas, experience, situation, sql, acc, o2-metricgrouping, o2-managementmodule, o2-alert, managementmodule, log, blob, perspective, metricgrouping, asm, inventory, event, attribute

Command Groups

agent

⤜ vertices..........................................: gets vertices for agent
⤜ trace.............................................: starts trace on specified agents
⤜ query-by-regex....................................: query by regex
⤜ query-by-name.....................................: ensure a specific agent exists.
⤜ metric-count-summary..............................: retrieves metric counts for agents as csv
⤜ count-via-atc.....................................: count agents using the /atc/agents request.
⤜ statuses..........................................: lists all agents statuses
⤜ list..............................................: lists all agents
⤜ licensing-beta....................................: generate licensing report with configuration
⤜ licensing.........................................: generate licensing report
⤜ licensing-config-generate.........................: creates a default licensingConfigFile to be modified for licensing-beta command.
⤜ attributes........................................: gets attributes for agent vertex
⤜ get-agent-traces..................................: retrieves traces
⤜ trace-summaries...................................: retrieves trace summaries for an agent

vertex

⤜ vertex-type-metric-mapping........................: dumps metric mapping for a vertex type
⤜ get-vertex-traces.................................: retrieves traces
⤜ get-vertex-trace-summaries........................: retrieves trace summaries for vertices
⤜ vertex-definitions................................: dumps all metric mappings for all vertices
⤜ vertex-definition.................................: dumps vertex definition for a single vertex type
⤜ attributes........................................: list ATC attributes
⤜ state.............................................: provides state on a single vertex
⤜ search............................................: search for matching vertices in a universe
⤜ search-all........................................: search for matching vertices in all universes
⤜ query-mapped-metrics..............................: executes metric query for a vertex's mapped metrics.
⤜ patch-universe....................................: patch matching vertices in a universe
⤜ override-vertex-metric-mapping....................: dumps performance specifier and metric root for a vertex type
⤜ generate-patch-from-csv...........................: generates a bulk-patch file from a CSV
⤜ detail............................................: provides detail on a single vertex
⤜ bulk-patch-schema.................................: generates the bulk-patch schema
⤜ bulk-patch-rollback...............................: rolls back a bulk-patch with a rollback file.
⤜ bulk-patch........................................: patches mutiple vertices using the bulk-patch file.
⤜ attribute-values..................................: gets values for an attribute
⤜ all-metric-mappings...............................: dumps all metric mappings for all vertices
⤜ add-vertex-definition.............................: add vertex definition from a file

auth

⤜ validate-configuration-keys.......................: validates keys
⤜ user-search.......................................: searches for users
⤜ list-groups.......................................: shows all authentication group names
⤜ current...........................................: shows auth of current token

dashboard

⤜ user-list.........................................: looks up a user by email
⤜ summarize-dashboard-tags..........................: shows a summary of all dashboards' tags.
⤜ set-theme.........................................: sets the current theme
⤜ set-folder-refresh-options........................: sets refresh options for all dashboards in folder
⤜ set-dashboard-refresh-options.....................: sets dashboard refresh options
⤜ replace-folder-tags...............................: replaces tags for all dashboards in a folder
⤜ replace-dashboard-tags............................: replaces tags for a dashboard
⤜ folder-list.......................................: show id/uid/title of all folders.
⤜ get-theme.........................................: shows the current theme
⤜ folder-permissions................................: gets permissions for a folder
⤜ get-dashboard-tags................................: shows current dashboard tags
⤜ get-dashboard-refresh-options.....................: shows current dashboard refresh options
⤜ folder-import.....................................: imports a folder and its dashboards from an export file.
⤜ folder-export.....................................: exports a folder and all dashboards in it.
⤜ folder-details....................................: show details for folder
⤜ dashboard-variables-list..........................: shows current values of dashboard variables
⤜ user-search.......................................: finds dashboard users
⤜ dashboard-update..................................: updates a dashboard from an export file.
⤜ dashboard-search..................................: finds dashboards
⤜ dashboard-list-by-folder..........................: lists dashboards in folder
⤜ dashboard-import..................................: creates a new dashboard from an export file.
⤜ dashboard-export..................................: exports a single dashboard
⤜ folder-create.....................................: creates a folder
⤜ add-folder-tags...................................: adds tags to all dashboards in a folder
⤜ folder-add-permission.............................: adds folder permission for a user by email or userId
⤜ add-dashboard-tags................................: adds tags to a dashboard

jsextension

⤜ upload............................................: upload a js extension file
⤜ list..............................................: list
⤜ enable............................................: enable js extension
⤜ disable...........................................: disable js extension
⤜ delete............................................: delete js extension

axa

⤜ upload-application-ba-extension...................: upload new custom AXA BrowserAgent extension javascript.
⤜ update-profile....................................: updates a AXA data collection profile
⤜ show-application-service-mapping..................: lists all AXA application names and their associated services
⤜ show-activity-tree................................: shows activity tree from session events
⤜ set-application-profile...........................: sets the profile by id for an AXA Application
⤜ servicify-application.............................: creates service and universe for 'orphaned' AXA applications
⤜ list-sessions.....................................: dumps filtered AXA session events
⤜ list-screens......................................: lists the screens available for business activities defined for an AXA Application
⤜ list-profiles.....................................: lists all AXA data collection profiles
⤜ list-applications.................................: lists all AXA application names/keys
⤜ list-activities...................................: lists the business activities defined for an AXA Application
⤜ import-profile....................................: import a AXA data collection profile
⤜ get-application-snippet...........................: gets AXA BrowserAgent snippet for an application
⤜ get-application-profile...........................: gets the profile/id for an AXA Application
⤜ get-application-ba-extension......................: gets AXA BrowserAgent extension javascript.
⤜ export-profile....................................: exports a AXA data collection profile
⤜ dump-sessions-events..............................: dumps filtered AXA session events
⤜ delete-application................................: delete an existing AXA application.
⤜ create-application................................: creates a new AXA application definition.
⤜ create-activity...................................: create a business activity for an AXA Application
⤜ crash-summary.....................................: summary of crashes
⤜ crash-list-by-group...............................: list crashes by group
⤜ crash-detail......................................: get details for a crash
⤜ crash-all.........................................: list all crashes
⤜ bulk-servicify....................................: creates service and universe for 'orphaned' AXA applications

config

⤜ upgrade...........................................: upgrade legacy dx-do configuration to current version
⤜ generate-user-token...............................: generates an user token
⤜ generate-agent-token..............................: generates an agent token
⤜ debug-token.......................................: shows decoded token
⤜ debug.............................................: shows configuration details
⤜ connector.........................................: shows connector config for tenant
⤜ create............................................: create new configuration interactively

channel

⤜ update-template...................................: update an existing channel message template
⤜ policy-detail.....................................: describes details for policy
⤜ list-templates....................................: lists all channel templates
⤜ list-policies.....................................: lists all channel policies
⤜ list..............................................: lists all channels
⤜ import............................................: imports channels/templates from file
⤜ export............................................: exports all channels/templates to file
⤜ enable-channel....................................: enable a channel
⤜ disable-channel...................................: disable a channel
⤜ create-velocity-maps-from-csv.....................: creates multiple velocity maps for use for advanced templates
⤜ create-velocity-map-from-csv......................: creates a velocity map for use for advanced templates
⤜ create-template...................................: create a channel message template

alert

⤜ update-summary....................................: update a summary alert.
⤜ update-simple.....................................: update a simple alert.
⤜ list-by-management-module.........................: lists all alerts in a management module.
⤜ list..............................................: lists all alerts.
⤜ enable-all........................................: enable all alerts for a management module
⤜ enable............................................: enable an alert.
⤜ disable-all.......................................: disable all alerts for a management module
⤜ disable...........................................: disable an alert.
⤜ debug-by-management-module........................: debug all alerts in a management module.
⤜ copy..............................................: copy an alert
⤜ copy-with-metric-grouping.........................: copy an alert with it's metric grouping
⤜ analyze...........................................: analyzes an alert and it's threshold
⤜ detail............................................: get alert definition

nass

⤜ update-metadata-attribute.........................: updates a metric's metadata attribute
⤜ report-metric-value...............................: reports a single metric value to a metric
⤜ register-metric...................................: registers a metric
⤜ query-metric-data.................................: executes a nass metric data query
⤜ query-metadata....................................: executes a nass metadata query
⤜ query-metadata-by-ids.............................: executes a nass metadata query
⤜ query.............................................: executes a nass query from file containing nassql query json

alarm

⤜ update-field......................................: updates an alarm field
⤜ unacknowledge.....................................: unacks an alarm
⤜ list..............................................: lists alarms
⤜ queue-detail......................................: dumps queue details
⤜ list-queues.......................................: lists alarm queues
⤜ list-enrichment-rules.............................: lists alarm enrichment rules
⤜ explain-enrichment-rules..........................: gives an simplified explanation of enrichment rules
⤜ clear.............................................: clears an alarm
⤜ bulk-lifecycle....................................: shows alarm lifecycle
⤜ assign............................................: assigns an alarm to a troubleshooter
⤜ analyze...........................................: shows counts of alarm by [source product] and managementmodule / type
⤜ trigger-webhook...................................: triggers a webhook for an alarm
⤜ related...........................................: gets related alarms
⤜ lifecycle.........................................: shows alarm lifecycle
⤜ detail............................................: dumps alarm details
⤜ create-alarm......................................: creates an alarm via jarvis ingestion
⤜ acknowledge.......................................: acknowledges an alarm

apm-universe

⤜ stats.............................................: provides detail on all APM universes
⤜ sanity-check......................................: ensures APM universes are not set up exceptionally badly.
⤜ list..............................................: lists all APM universes
⤜ export............................................: dumps a single APM universe json
⤜ detail............................................: provides detail on a single APM universe
⤜ delete............................................: deletes an APM universe
⤜ create............................................: creates an APM universe
⤜ add-metric-source.................................: adds an agent / regex to an APM universe definition.

o2-universe

⤜ services..........................................: lists services associated with a universe
⤜ list..............................................: lists all O2 universes
⤜ export............................................: dumps a single O2 universe JSON
⤜ create............................................: creates a o2 universe

trace

⤜ trace-details.....................................: get trace details for traceId
⤜ query-threaddumps.................................: find threaddumps for an agent
⤜ get-threaddump....................................: retrieve a previously collected threaddump
⤜ collect-threaddump................................: trigger a trace on an agent
⤜ get-agent-traces..................................: retrieves traces

topographer

⤜ test-configuration................................: test a topographer configuration
⤜ generate-sample...................................: generate a sample topographer configuration
⤜ dump-schema.......................................: dumps the topographer configuration schema (for use in IDE)

service

⤜ top-level-services................................: shows top level services
⤜ search............................................: show services matching search term
⤜ slis..............................................: show the service SLIs (and child service SLIs)
⤜ overview..........................................: dump the service overview as json
⤜ metrics...........................................: dump the service metrics as json
⤜ inventory-overlap.................................: shows inventory overlaps for services
⤜ inventory.........................................: shows inventory for a service
⤜ dependency-graph..................................: shows a dependency graph for a service
⤜ delete-service....................................: deletes service (and optionally it's subservices)
⤜ create-empty-service..............................: creates a simple empty service
⤜ all-services......................................: shows all services

help

⤜ time-formats......................................: explains time formats for 'metric data' and 'agent get-trace-sumaries'.
⤜ bulk-patch........................................: explains vertex bulk-patch
⤜ dashboard.........................................: explains dashboard command setup.
⤜ configuration.....................................: explains configuration
⤜ commands-md.......................................: explains commands in md format
⤜ commands..........................................: explains commands.

graph

⤜ test-vertex-type-mapping..........................: tests vertexes for type mapping
⤜ summary...........................................: summarizes vertices & edges
⤜ summary-at........................................: summarizes vertices & edges at a specific time
⤜ store.............................................: stores vertexes and edges using the (legacy) APM interface
⤜ status-check......................................: summarizes vertices alerts
⤜ export............................................: exports universe graph at a configurable time
⤜ summarize-edges...................................: summarizes application edges

metric

⤜ test-time-format..................................: allows testing of time parsing
⤜ data-metric.......................................: gets metric values for a single metric.
⤜ id................................................: gets metric id for a single metric.
⤜ data..............................................: gets metric values
⤜ attributes........................................: gets attributes for metric (or metric's agent, if metric doesn't belong to a vertex)

metrex

⤜ test-configuration................................: test a metrex configuration
⤜ generate-vertex-definition........................: generate a vertex definition from a metrex configuration
⤜ generate-sample...................................: generate a sample metrex configuration schema
⤜ dump-schema.......................................: dumps the metrex configuration schema (for use in IDE)
⤜ associate-vertex-metrics..........................: associate metrics to vertices using the output of test-configuration command.

tas

⤜ store-graph.......................................: stores vertexes and edges
⤜ query-json........................................: executes a query defined in a json file
⤜ query-all.........................................: finds everything
⤜ query-agents......................................: finds everything

experience

⤜ summarize.........................................: summarizes an experience
⤜ list..............................................: lists Experience names & ids 
⤜ import............................................: imports an experience configuration from file 
⤜ export............................................: exports an experience configuration
⤜ settings..........................................: lists Experience settings
⤜ report............................................: reports on various parts of an experience hierarchy.
⤜ mapping...........................................: shows mapping from Experience Top-Level to Settings ID
⤜ delete............................................: delete an experience carefully
⤜ dashboard.........................................: summarizes experience dashboard
⤜ create............................................: creates an experience

situation

⤜ trigger-webhook...................................: triggers a webhook for a situation
⤜ summary...........................................: show the generative AI summary for a situation
⤜ inspect-alarms....................................: provides alarms from situation inspection 
⤜ inspect...........................................: provides entire situation inspection json
⤜ detail............................................: show details for situation
⤜ alarm-data........................................: provides the situation alarm data
⤜ query.............................................: finds situations

sql

⤜ examples..........................................: shows example queries
⤜ query.............................................: executes an APM sql query
⤜ date-to-timestamp.................................: converts dates to timestamps for use in queries

acc

⤜ package-details...................................: gets package details
⤜ package-bundles...................................: gets package bundles
⤜ list-packages.....................................: lists acc packages
⤜ list-bundles......................................: lists acc bundles
⤜ initialize-bundle-directory.......................: initialize a prepared bundle directory
⤜ import-packages...................................: import packages from an export file
⤜ import-bundle.....................................: import bundle from a bundle tar.gz file
⤜ export-packages...................................: exports packages to a file
⤜ download-bundle...................................: downloads bundle
⤜ bundle-details....................................: gets bundle details

o2-metricgrouping

⤜ update............................................: updates a platform metric grouping
⤜ list..............................................: lists platform metric groupings, optionally filtered by management module
⤜ detail............................................: shows full detail of a platform metric grouping
⤜ delete............................................: deletes a platform metric grouping (dry-run by default)
⤜ create............................................: creates a new platform metric grouping (dry-run by default)

o2-managementmodule

⤜ update............................................: updates a platform management module
⤜ list..............................................: lists all platform management modules
⤜ delete............................................: deletes a platform management module (dry-run by default)
⤜ create............................................: creates a new platform management module (dry-run by default)

o2-alert

⤜ update............................................: updates a platform alert spec (dry-run by default)
⤜ list..............................................: lists platform alert specs, optionally filtered by management module
⤜ detail............................................: shows full detail of a platform alert spec
⤜ delete............................................: deletes a platform alert spec (dry-run by default)
⤜ create............................................: creates a new platform alert spec (dry-run by default)

managementmodule

⤜ update............................................: updates a management module.
⤜ list-calculators..................................: lists calculators in a management module
⤜ download..........................................: downloads a management module
⤜ delete............................................: delete a management module
⤜ create............................................: creates a management module.
⤜ copy..............................................: copy a management module.
⤜ list..............................................: lists all management modules.
⤜ import............................................: imports a management module from json
⤜ export............................................: exports a management module and its metric groupings, alerts and calculators.

log

⤜ query.............................................: queries DXO2 Log analytics

blob

⤜ list-schemas......................................: list current blob schemas
⤜ list-blobs........................................: list blobs for a schema
⤜ fetch.............................................: fetches the content of a blob

perspective

⤜ list..............................................: List Map View Perspectives
⤜ import............................................: Import Map View Perspective
⤜ export............................................: Export Map View Perspective
⤜ delete............................................: Delete Map View Perspective

metricgrouping

⤜ list-by-managementmodule..........................: lists all metric groupings in management modules.
⤜ list-metrics......................................: lists all live metrics in metric grouping

asm

⤜ list-folders......................................: lists asm folders

inventory

⤜ sources...........................................: lists all sources of inventory items
⤜ search............................................: searches inventory
⤜ metrics...........................................: finds metrics associated with inventory
⤜ lookup............................................: searches inventory using free text search, be aware that this may not support all product sources
⤜ layers............................................: lists all topology layers with a count of entities on each layer
⤜ list-inventorize-rules............................: shows rules for creating inventory from metrics
⤜ delete-inventorize-rule...........................: deletes an inventorize rule
⤜ create-inventorize-rule...........................: creates a rule for creating inventory from metrics, dryrun mode by default, set mode=create to execute.
⤜ attributes........................................: list all available attributes

event

⤜ query-change-events...............................: execute lucene query for change events
⤜ create-event......................................: creates a plain event
⤜ create-change-event...............................: creates a change event

attribute

⤜ dump..............................................: dumps all attributes by layer

Options

Insecure HTTPS for Non-Proxied On-Prem

You may set the ALLOW_INSECURE_HTTPS environment variable to true in order to use self-signed or expired certificates

export ALLOW_INSECURE_HTTPS=true
npx @dx-do/cli alert list

current version 4 configuration file format

{
  "configurationVersion": "3"
  "cohortId": "<cohortUD from Settings -> Connector Parameters>",
  "userToken": <DX User Token from Settings -> Manage Tokens -> New Token -> User>,
  "dxGatewayHost": "https://apmgw.dxi-na1.saas.broadcom.com/",
  "dxASMToken": <optional token for ASM API usage> 
}

config

--config=<configFilename>

proxyConfig

--proxyConfig=<proxyConfigFilename>

proxy config File Format

{
  "protocol": "http", // or https
  "host": "localhost",
  "port": 8888,
  "auth": {
    "username": "myuser",
    "password": "mypass"
  }
}

non interactive mode (suitable for running from a script)

--noninteractive

version 3 configuration

Please upgrade version 3 configurations using "config upgrade"

{
    "hostUrl":"https://apmgw.dxi-na1.saas.broadcom.com/",
    "apiKey":"<APM_API_TOKEN>",
    "tenantCN":"TENANT_NAME",
    "tenantId":"000"
    "oiUserKey": "<OI_USER_TOKEN>",
    "axaHostUrl": "https://axa.dxi-na1.saas.broadcom.com/",
    "oiHostUrl": "https://oi.dxi-na1.saas.broadcom.com/",
}