Skip to end of metadata
Go to start of metadata

Debug

Use debugging functions

debug <option> Enable debugging output

debug <option> level <0-15> Minimum debug level to show

debug <option> level none Disable a facilities debugging output

CLI debug options

Option

Modifier

Description

all


Enable all possible debugging output

cli

level <0-15>

Enable CLI debugging output

db

level <0-15>

Enable database debugging output

ibp

level <0-15>

Enable IBP debugging output

none


Disable all possible debugging output

sig

level <0-15>

Enable signalling debugging output

There are sixteen levels ranging from 0-15. 0 displays all messages and 15 displays only Panic or Emergency messages.

show

Displays information about VX's state.

show <option> <modifier>

CLI show options

Option

Modifier

Description

debug


Show the status of debugging output

licenses


Show the system license settings

services


Show the status of internal services

snpp


Show the SNPP client settings

terminal


Show info about your terminal

users


Show info about user accounts

version


Show info about VX

who


Show users online

sql


Show the SQL server settings

When multiple items are requested the command will provide a summary display unless "full" is indicated.

configure

Enter configure mode.

VXgate/config#?

no Negates the effect of the command

interface Choose the interface to work with

node-id Change node ID of this machine

user User management commands

snpp Configure the SNPP client

cdr Configure default CDR handling

debug Enable debugging file

sql Configure SQL server communication

exit Exit configuration mode

configure--interface

Configure system-wide IP parameters

interface <option> <modifier>

interface Options

Option

Modifier

Description

ip

<0-61>

Enter the interface number's mode

default-route

<a.b.c.d>

Address of the default route

ethernet-port

<0-61>

Ethernet port number


configure-interface-ip

Configure the IP address for this interface

VXgate/config/ip 1#?

no Negates the effect of the command

ip Configure the IP address for this interface

shutdown Shutdown this interface

exit Exit interface configuration mode

ip <option> <modifier>

ip Options

Option

Modifier

Description

broadcast-address

<a.b.c.d>

Set the broadcast address

address

<a.b.c.d> <a.b.c.d> <a.b.c.d>

Set the IP, net mask, broadcast addresses for this interface

peer-address

<a.b.c.d>

Set the IP address of the peer

ethernet-port

<0-61>

Set the ethernet port to bind to


configure-interface-shutdown

Shut down this interface

<no> shutdown


configure-interface-exit

Exit the current mode

exit


configure--node-id

Set the unique node ID of this machine for the VX network.configure--user

node-id <a.b.c.d>
node-ID

Option

Modifier

Description

node-id

a.b.c.d

IP address of the VX node, in dotted decimal format


User Management Commands

user <option> <modifier>

user Options

Option

Modifier

Description

add

<name> access <0-14> password < password >

Add a new user, access level, and default password

change

<name> access <0-15> password < password >

Change a user's settings access level, and password

<name> default-access <0-14>

Set the user's default access level

delete

<name>

Remove a user

remove

<name> access <0-15>

Remove a user's password for an access level

disable

<name>

Disables a user's access

enable

<name>

Enables a user's access


configure--snpp

Configure the SNPP client

snpp <option> <modifier>

snpp Options

Option

Modifier

Description

enable


Enable the SNPP client

disable


Disable the SNPP client

minimum-level

<level>

Set the minimum severity to send a page.

  • normal sets the page on normal alarms
  • information sets the page on information alarms.

warning

Page on warning alarms

error

Page on error alarms

critical

Page on critical alarms

alert

Page on alert alarms

emergency

Page on emergency alarms


configure--cdr

Configure default CDR logging parameters

cdr <option> <modifier>

CDR options

Option

Modifier

Description

max-threads

<1-45>

Set the maximum number of CDR threads used from 1-45. Each thread makes a new connection to the SQL server.
max-threads and max-queue should not be changed under normal circumstances
The default value is 5

max-queue

<2-99>

Sets the desired queue depth per thread. When a queue is backlogged with this many requests, the system tries to spawn a new thread, The default is 30.


configure--debug

Enable logging of debug file. Enables (or disables if no is specified) logging to the debug file, which is stored in C:\VX\Public\Debug.

[no] debug


configure--sql

Configure access to the SQL server.

sql <option> <modifier>

sql Options

Option

Modifier

Description

server

<name>

The name or IP address of the SQL server. the VXgate must be able to resolve this address.
This setting is valid only when used in the ODBC connection string, as configured by VXgate Config.

database

<name>

The name of the database to use. This must be a version 1002 or 1003 VX database.
This setting is valid only when used in the ODBC connection string, as configured by VXgate Config.

username

<name>

The SQL Server user to log into the database as. This user must have sufficient rights to look up rates and to update the CDR tables.
This setting is valid only when used in the ODBC connection string, as configured by VXgate Config.

password

<password>

The password for the SQL server user to log in with. This setting is valid only when used in the ODBC connection string, as configured by VXgate Config.

debug

<none>

Enable inclusion of BDAP SQL statements in debug log. (To disable, use 'no sql debug') This option takes effect immediately.

configure--exit

Exit configure mode and return to the basic command mode.


enable

Enter command mode for your privilege level. You must use the enable command to access the Config Mode commands.

enable <0-15>


exit

Exit the CLI and terminate the login session.

exit

logout

Immediately terminate the current session.

logout

quit

Immediately terminate the current session.

quit

halt

Shut down VX

halt

password

Change your default password. This is a prompt-driven command.

password

system

Set a system shutdown or reboot.

system <option> <modifier>

system Options

Option

Modifier

Description

shutdown

now

Shutdown the host system

cancel

Cancel a pending operation

reboot

now

Reboot the host system

cancel

Cancel a pending operation