diagdata is a CLI tool that is used to aid diagnostic testing of Ops Center Protector. It provides the following functions:
- Stopping and starting of Ops Center Protector services
- Resetting the Ops Center Protector system state
- Raising and lowering of trace level for diagnostics
- Collection of Ops Center Protector state information to aid investigation of issues
Command line options
| Abbreviated argument | Full argument | Description |
|---|---|---|
| -h | --help | Display help. |
| Abbreviated argument | Full argument | Description |
|---|---|---|
| -r arg | --restart arg | Auto restart active services yes | no |
| --start arg |
Starts the hub service. Options are none, all, hub. ‘none’ means no argument is required. |
|
| --stop arg |
Stops the hub service. Options are none, all, hub. ‘none’ means no argument is required. |
|
| Abbreviated argument | Full argument | Description |
|---|---|---|
| -d arg | --trace-dir arg | Set the trace directory. |
| -T arg | --temp-dir arg | Set the temp directory. |
| --reset |
Resets the state of the Ops Center Protector node and flushes cache and logs. Can only be run if Ops Center Protector services are stopped (see --stop). |
|
| Abbreviated argument | Full argument | Description |
|---|---|---|
| -f | --full | Produce a full dump of the Ops Center Protector configuration on the system, including all trace files. Results are placed in a ZIP file named: diag_node name_YYYYMMDDhhmm.zip in the directory: Data-Instance-Director-install\runtime This ZIP file can be requested by Hitachi Vantara support when investigating complex end user issues. Can be combined with --spilt |
| -m | --mini | Similar to –f but only saves a recent portion of all trace files. Can be combined with --spilt |
| -c arg | --collect arg | arg specifies which data must be collected. Use all to collect all components. For additional component names use -c help. Can be combined with --spilt |
| -o arg | --output-dir arg | arg specifies an optional output directory. Default is Protector\runtime |
| -n arg | --tracename arg | arg specifies a filter mask which uses wildcards to target only specific trace files e.g. diagdata -f --tracename repos*. Multiple filters can be used seperated by ';' e.g. hub*;node*;repo*. For Linux use "hub*;node*;repo*"). |
| -a arg | --traceage arg | arg specifies an age, in days, to target only trace files modified in that time frame. |
| -z | --nosnapshots | Prevents diagdata from creating snapshots before a dump (this may result in some files not being added to the diagnostic dump). |
| -Z | --withsnapshots | Attempt diagdata snapshots regardless of configuration. The default mode of
operation. For linux , snapshots will only be taken for LVM filesystems |
| --no-md5 | Disable MD5 checksum on created zip files. | |
| Abbreviated argument | Full argument | Description |
|---|---|---|
| -t arg | --trace arg |
Sets the trace level of the node. Valid arguments are: TraceAlways – TraceTesting, TraceNormal, TraceVerbose TraceDebug Trace files are placed in the directory: [Install-Dir]\runtime\trace |
| -p | --deltrace | Delete inactive trace files. Any trace files currently in use by the Protector system will not be deleted. Deletes the contents of [Install-Dir]\runtime\trace |
| -x | --delalltrace | Stop Protector services, delete all trace and then restart them. |
| -i | --info | Get information about this node and current trace status. |
| Abbreviated argument | Full argument | Description |
|---|---|---|
| -l arg | --dumplevel arg | Not available on Linux. Sets Protector crash dump level full | default. |
| --test-dump | Not available on Linux. Generates a Windows dump file for test purposes. | |
| Abbreviated argument | Full argument | Description |
|---|---|---|
| -S arg | --split-file arg | Split an existing zip file (path specified by arg) into multiple chunks (configurable, 1GB default). Intended to be used if the file is too big to be uploaded to a file service. |
| -C arg | --concatenate arg | File name for the concatenated file. That must be followed by the list of the files to be concatenated. Example: --concatenate diag.zip part.000 part.001 part.002 |
| --split | Split the zip in multiple chunks (configurable, 1GB default), this is used with the --full, --mini and --collect options. Intended to be used if the file is too big to be uploaded to a file service. | |
Usage Examples:
Stopping the Ops Center Protector services on any node:
diagdata --stop
Setting the trace level of the Ops Center Protector services on any node:
diagdata --trace TraceAlways
Collect a mini dianostic log from a node:
diagdata --mini
Collect a full diagnostic log from a node:
diagdata --full