sipvicious utils dump configuration

This documentation applies to SIPVicious version v6.0.0-beta.3. Please note that only the latest version of SIPVicious PRO is supported.

Summary

Dump an example configuration file

What it does

SIPVicious supports configuration files in various formats; this command prints an example configuration file in the file format specified, TOML being default

Tool functionality

The dump configuration command is used to show the current configuration status. This is great when trying to get an example of the default settings for any sipvicious tool. The tool outputs the contents to standard output, which can be redirected to a file or piped to another tool if need be.

Command format

sipvicious utils dump configuration [flags]

Flags

  -f, --format string   Specify type of shell (toml|yaml|json) (default "toml")

Flags inherited from parent commands

  -C, --config string    configuration file to use (may be JSON, TOML or YAML)
      --debug            set log level to debug
      --logfile string   specify a log filename
      --results string   specify the filename for the result output, defaults to standard output. See documentation for information on file extension meanings

Flag: -C, --config

Specify a configuration file which may be a JSON, TOML and YAML config format. To get the default settings and figure out which settings are available, one may run the sipvicious utils dump config command. This is typically used to create a template configuration that can then be edited as need be.

These settings may be overwritten when the corresponding flag is explicitly set, if one is present.

Flag: --debug

Tells the logger to print out debug messages.

Flag: -f, --format

Specify any of the supported formats: TOML, YAML or JSON.

Flag: --logfile

When the logfile flag is specified, a log file is created in the location specified and logs are generated in this file instead of being sent to standard output. If the filename ends with a .json file extension, then the output format is in JSON, otherwise it defaults to text format.

Flag: --results

When the results flag is specified, upon completing the test, it outputs the results to the specified filename. The format for this output file is text unless the filename ends with a .json file extension. In that case, the result output is that of JSON.

The schema for the JSON output for this submodule can be found here.

JSON schema

The following is the JSON schema for the JSON output of this tool:

{
  "type": "object",
  "properties": {
    "status": {
      "type": "object",
      "properties": {
        "returncode": { "type": "integer" },
        "description": { "type": "string" }
      }
    },
    "targets": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "target": { "type": "string" },
          "status": {
            "type": "object",
            "properties": {
              "returncode": { "type": "integer" },
              "description": { "type": "string" }
            }
          },
          "results": {
            "type": "object",
            "properties": {
            }
          },
          "issues": {
            "type": "object",
            "properties": {
            }
          }
        }
      }
    }
  }
}

Further details can be read at the configuration documentation