Bulk Statistics Config Mode Command Reference

bulk-stats

Configures bulk statistics parameters.

Command Mode

Exec > Global Configuration

Syntax

bulk-stats { enable { false | true } | user user_name | external-ip ip_address | external-port port_number | interval-minutes create_interval | prune-interval-days prune_interval | vnf-name vnf_name | global-default-value global_default_value | global-default-namespace global_default_namespace} 

enable { false | true}

Specify to enable or disable bulk statistics.

Must be one of the following:

  • false

  • true

Default Value: true.

external-ip ip_address

Specify the external IP address for downloading the bulk statistics over SFTP.

Must be an IPv4 address.

-Or-

Must be an IPv6 address.

external-port port_number

Specify the external port number for downloading the bulk statistics over SFTP.

Must be an integer.

Default Value: 2222.

global-default-namespace global_default_namespace

Specify the namespace used in the bulk statistics file if the query did not return any value.

Must be a string.

global-default-value global_default_value

Specify the value used in the bulk statistics file if the query did not return any value.

Must be a string.

interval-minutes create_interval

Specify the interval for creating the bulk statistics in minutes.

Must be an integer.

Default Value: 1.

prune-interval-days prune_interval

Specify the time interval, in number of days, to remove the bulk statistics.

Must be an integer.

Default Value: 1.

user user_name

Specify the user authorized to download the bulk statistics.

Must be a string.

Default Value: admin.

vnf-name vnf_name

Specify the VNF name to be added to the bulk statistics CSV file.

Must be a string.

Default Value: default.

Usage Guidelines

Use this command to configure bulk statistics parameters.

bulk-stats current

Displays the list of current bulk statistics.

Command Mode

Exec > CEE

Syntax

show bulk-stats current [ uid unique_id | namespace bulk_statistics_namespace | key bulk_statistics_key | label bulk_statistics_label | value bulk_statistics_value ] 

alias bulkstats_alias

Specify the bulkstats alias.

Must be a string.

labels bulkstat_labels

Specify multiple bulkstat labels.

Must be a string.

metric bulkstats_metric

Specify the bulkstats metric name.

Must be a string.

namespace bulk_statistics_namespace

Specify the bulk statistics namespace.

Must be a string.

uid unique_id

Specify the unique identifier.

Must be a string.

value bulk_statistics_value

Specify the value of the bulk statistics.

Must be of type decimal64, with 3 fraction digits.

Usage Guidelines

Use this command to view the list of current bulk statistics.

bulk-stats pod-query

Configures the queries for retriving the bulk statistics.

Command Mode

Exec > Global Configuration

Syntax

bulk-stats pod-query field_name { query query_name | rate-query rate_query_name | default-value default_value} 

default-value default_value

Specify the value used in the bulk statistics file if the query did not return any value.

Must be a string.

query query_name

Specify the query to be executed in Prometheus Query Language (PromQL). The query must be groupped by namespace and pod_name or pod.

Must be a string.

rate-query rate_query_name

Specify the rate query to be executed in PromQL format. The rate query must use rate (not irate) and include group by namespace and pod_name (or pod). Use $INTERVAL for interval.

Must be a string.

field_name

Specify the name of the field to add to the pod statistics.

Must be a string.

Usage Guidelines

Use this command to configure the queries for retriving the bulk statistics.

bulk-stats query

Configures the query to retrive bulk statistics data.

Command Mode

Exec > Global Configuration

Syntax

bulk-stats query query_name { expression expression | label label | default-value default_value | default-namespace default_namespace} 

alias bulkstats_alias

Specify the bulkstats alias.

Must be a string.

default-namespace default_namespace

Specify the namespace used in bulk statistics file if the query did not return any value.

Must be a string.

default-value default_value

Specify the value used in bulk statistics file if the query did not return any value.

Must be a string.

expression expression

Specify the query to execute in PromQL format.

Must be a string.

label bulkstat_label

Specify a single bulkstat label. Stats will populate the label in AVP format.

Must be a string.

labels bulkstat_labels

Specify multiple bulkstat labels. Stats will populate the label in AVP format separated by semicolon (;).

Must be a string.

query_name

Specify the query name.

Must be a string.

Usage Guidelines

Use this command to configure the query to execute to retrive the bulk statistics data.

bulk-stats vnf-alias

Configures the VNF alias for a given namespace.

Command Mode

Exec > Global Configuration

Syntax

bulk-stats vnf-alias namespace alias alias 

alias alias

Specify the alias to apply.

Must be a string.

namespace

Specify the namespace to apply the alias.

Must be a string.

Usage Guidelines

Use this command to configure the VNF alias for a given namespace.