cc/td/doc/product/access/acs_soft/rpms/rpms_1-0
hometocprevnextglossaryfeedbacksearchhelp

Table of Contents

Using the Command-Line Interface

Using the Command-Line Interface

The Cisco Resource Pool Manager Server (Cisco RPMS) command-line interface (CLI) enables the system administrator to carry out simple Cisco RPMS administration tasks from a UNIX command-line.

Using this CLI, the system administrator can either issue single Cisco RPMS administration commands and arguments from the UNIX shell, or create scripts that execute a sequence of commands.

Running the CLI

You can only run the Cisco RPMS CLI from the host machine for Cisco RPMS. Log in as root and change to the $BASEDIR/bin directory. Enter the Cisco RPMS commands from the UNIX command-line prompt.

The remaining sections in this chapter describe the syntax and usage of the Cisco RPMS commands.

CreateCallDiscrimination

To add a call discrimination record to the Cisco RPMS database, use the CreateCallDiscrimination command.

Command Syntax

CreateCallDiscrimination [-p port] [-id client] [-q] [-] [-h] NAME=name DNIS=dnisgroup CALLTYPE=calltype

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) Call discrimination name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

CALLTYPE

(Required) Call type (bearer capability). The valid characters are all alphabetic characters (uppercase and lowercase) and digits 0 through 9. The maximum number of characters is 32.

DNIS

(Required) DNIS group name. The valid characters are all alphabetic characters (uppercase and lowercase) and digits 0 through 9. The maximum number of characters is 32. The DNIS group specified here must already exist in the Cisco RPMS database.

System Messages

RC1 Message Description

2

Call Discrimination already exists.

Call discrimination already exists in the Cisco RPMS database.

3

Call type does not exist in Cisco RPMS server.

Call type does not exist in the Cisco RPMS database.

4

Unable to retrieve Call Type.

Unable to retrieve the call type from the Cisco RPMS database.

5

DNIS group does not exist in Cisco RPMS server.

DNIS group does not exist in the Cisco RPMS database.

6

Unable to retrieve DNIS group.

Unable to retrieve the DNIS group from the Cisco RPMS database.

7

Call type/DNIS group associations must be unique across all Call Discriminations.

The DNIS group and call type have already been used to define an existing call discrimination. Use a DNIS group and call type association that has not been used before.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example creates a call discrimination, TestCD, that prevents speech access for the DNIS group, DNISGroup1:

CreateCallDiscrimination NAME=TestCD CALLTYPE=speech DNIS=DNISGroup1

DeleteCallDiscrimination

To delete a call discrimination record from the Cisco RPMS database, use the DeleteCallDiscrimination command.

Command Syntax

DeleteCallDiscrimination [-p port] [-id client] [-q] [-] [-h] NAME=name

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) Call discrimination name. All characters are valid except angle brackets (< >), double quotation marks (") and backslash (\). The maximum number of characters is 32.

System Messages

RC1 Message Description

1

Call Discrimination not found.

Call discrimination was not found in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example deletes the call discrimination, CD1, from the Cisco RPMS database:

DeleteCallDiscrimination NAME=CD1

CreateCallType

To add a call type record to the Cisco RPMS database, use the CreateCallType command.

Command Syntax

CreateCallType [-p port] [-id client] [-q] [-] [-h] NAME=name [DESC=description]

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) Call type name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

DESC

Call type description. To use spaces within a description, enclose the description in double quotation marks. However, double quotation marks cannot appear within the description itself. All other characters are valid. The maximum number of characters is 128.

System Messages

RC1 Message Description

2

Call Type already exists.

Call type already exists in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example creates the call type, digital, in the call type table in the Cisco RPMS database:

CreateCallType NAME=digital DESC="This is a call type description"

DeleteCallType

To delete a call type record from the Cisco RPMS database, use the DeleteCallType command.

Command Syntax

DeleteCallType [-p port] [-id client] [-q] [-] [-h] NAME=name

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) Call type name. The valid characters are all alphabetic characters (uppercase and lowercase) and digits 0 through 9. The maximum number of characters is 32.

System Messages

RC1 Message Description

1

Call Type not found.

Call type was not found in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example deletes the call type, MyCallType, from the call type table in the CiscoSecure RPMS database:

DeleteCallType NAME=MyCallType

CreateCustomer

To create customer profile in the Cisco RPMS database, use the CreateCustomer command.

Command Syntax

CreateCustomer [-p port] [-id client] [-q] [-] [-h] NAME=name [DESC=description] CALLTREAT=calltreatment [SESSLMT=slimit] [SESSTHLD=sthreshold] [OVERLMT=olimit] [OVERTHLD=othreshold] [OVERREJTHLD=orthreshold] [CALLREJTHLD=crthreshold] [ADDDNIS=dnisgroup] [ADDRES=resource] [ADDVPDN=vpdngroup]

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) Customer name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

DESC

Customer description. To use spaces within a description, enclose the description in double quotation marks. However, double quotation marks cannot appear within the description itself. All other characters are valid. The maximum number of characters is 128.

CALLTREAT

(Required) Call treatment. Valid values are no-answer, busy and channel-unavailable.

SESSLMT

Non-overflow session count limit. This tag accepts the keyword NOLIMIT, which sets the customer profile's non-overflow session count limit to unlimited. The default value is 100.

SESSTHLD

Non-overflow session count threshold. This tag accepts the keyword DISABLED, which disables the non-overflow session count threshold. The maximum value is 99. The default value is 85.

OVERLMT

Maximum number of overflow sessions above the session count. This tag accepts the keyword NOLIMIT, which sets the customer profile's overflow session limit to unlimited. The default value is 10.

OVERTHLD

Overflow threshold. This tag accepts the keyword DISABLED, which disables the overflow threshold. The maximum value is 99. The default value is 85.

OVERREJTHLD

Overflow call rejection threshold. This tag accepts the keyword DISABLED, which disables the overflow call rejection threshold. The maximum value is 99. The default value is 85.

CALLREJTHLD

Call rejection threshold. This tag accepts the keyword DISABLED, which disables the call rejection threshold. The maximum value is 99. The default value is 85.

ADDDNIS

Creates an association to the specified DNIS group and call type pair. The DNIS group and call type must be separated by a comma, for example, ADDDNIS=DNISGroup1,speech. The maximum number of characters is 256. The DNIS group and call type specified here must already exist in the Cisco RPMS database.

ADDRES

Creates an association to a specified resource group, call type, and resource service grouping. The resource group, call type, and resource service must be separated by commas, for example, ADDRES=ResourceGroup1,speech,ResourceService1. The combination of resource group and call type must be unique for this customer. The resource service is optional. The maximum number of characters is 256. This tag can be used more than once on the command-line. The resource group and resource service specified here must already exist in the Cisco RPMS database.

ADDVPDN

Creates an association to the specified VPDN Group. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32. The VPDN group specified here must already exist in the Cisco RPMS database.

System Messages

RC1 Message Description

2

Customer already exists.

Customer name already exists in the Cisco RPMS database.

3

Invalid Call Treatment provide in CALLTREAT switch.

Call treatment is invalid. Check the syntax for this command for the valid CALLTREAT values.

4

One or more VPDN Groups do not exist.

VPDN group in the ADDVPDN tag does not exist in the Cisco RPMS database.

5

Error exists in one or more ADDDNIS tags.

Value specified incorrectly in ADDDNIS tag. Check the syntax for the ADDDNIS tag.

6

Unable to add one or more Customer Resource associations.

Customer resource association was not successfully added.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example creates a customer profile for TestCustomer, with no associations, in the Cisco RPMS database:

CreateCustomer NAME=TestCustomer DESC="This is a test customer" CALLTREAT=busy SESSLMT=100 SESSTHLD=10 OVERLMT=100 OVERTHLD=10

UpdateCustomer

To update information in a customer profile, use the UpdateCustomer command.

Command Syntax

UpdateCustomer [-p port] [-id client] [-q] [-] [-h] NAME=name [DESC=description] [CALLTREAT=calltreatment] [SESSLMT=slimit] [SESSTHLD=sthreshold] [OVERLMT=olimit] [OVERTHLD=othreshold] [OVERREJTHLD=orthreshold] [CALLREJTHLD=crthreshold] [ADDDNIS=adnisgroup] [REMDNIS=rdnisgroup] [ADDRES=aresource] [REMRES=rresource] [ADDVPDN=avpdngroup] [REMVPDN=rvpdngroup]

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) Customer name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

DESC

Customer Description. To use spaces within a description, enclose the description in double quotation marks. However, double quotation marks cannot appear within the description itself. All other characters are valid. The maximum number of characters is 128.

CALLTREAT

Call treatment. Valid values are no-answer, busy and channel-unavailable.

SESSLMT

Non-overflow session count limit. This tag accepts the keyword NOLIMIT, which sets the customer profile's non-overflow session count limit to unlimited. The default value is 100.

SESSTHLD

Non-overflow session count threshold. This tag accepts the keyword DISABLED, which disables the non-overflow session count threshold. The maximum value is 99. The default value is 85.

OVERLMT

Maximum number of overflow sessions above the session count. This tag accepts the keyword NOLIMIT, which sets the customer profile's maximum number of overflow sessions limit to unlimited. The default value is 10.

OVERTHLD

Overflow threshold. This tag accepts the keyword DISABLED, which disables the overflow threshold. The maximum value is 99. The default value is 85.

OVERREJTHLD

Overflow call rejection threshold. This tag accepts the keyword DISABLED, which disables the overflow call rejection threshold. The maximum value is 99. The default value is 85.

CALLREJTHLD

Call Rejection threshold. This tag accepts the keyword DISABLED, which disables the call rejection threshold. The maximum value is 99. The default value is 85.

ADDDNIS

Creates an association to the specified DNIS group and call type pair. The DNIS group and call type must be separated by a comma, for example, ADDDNIS=DNISGroup1,speech. The maximum number of characters is 256. The DNIS group and call type specified here must already exist in the Cisco RPMS database.

REMDNIS

Removes the association to the specified DNIS group and call type pair. The DNIS group and call type must be separated by a comma, for example, ADDDNIS=DNISGroup1,speech. The maximum number of characters is 256. This tag can be used more than once on the command-line.

ADDRES

Creates an association to a specified resource group, call type, and resource service grouping. The resource group, call type and resource service must be separated by commas, for example, ADDRES=ResourceGroup1,speech,ResourceService1. The combination of resource group and call type must be unique for this customer. The resource service is optional. The maximum number of characters is 256. This tag can be used more than once on the command-line. The resource group and resource service specified here must already exist in the Cisco RPMS database.

REMRES

Removes the association to the specified resource group, call type, and resource service grouping. The resource group, call type and resource service must be separated by commas, for example, REMRES=ResourceGroup1,speech,ResourceService1. The combination of resource group and call type must be unique for this customer. The resource service is optional. The maximum number of characters is 256. This tag can be used more than once on the command-line.

ADDVPDN

Creates an association to the specified VPDN Group. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32. The VPDN group specified here must already exist in the Cisco RPMS database.

REMVPDN

Removes the association to the specified VPDN Group. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32. This tag can be used more than once on the command-line.

System Messages

RC1 Message Description

1

Customer profile does not exist in Cisco RPMS Server

Customer does not exist in the Cisco RPMS database.

3

Invalid Call Treatment provided in CALLTREAT switch.

Call treatment specified is invalid. Check the syntax for this command for the valid CALLTREAT values.

4

Unable to add one or more VPDN Group associations.

VPDN group association was not successfully added.

5

Unable to remove one or more VPDN Group associations.

VPDN group association was not successfully removed.

6

Unable to add one or more DNIS/Call type associations.

DNIS group and call type pair association was not successfully added.

7

Unable to remove one or more DNIS/Call type associations.

DNIS group and call type pair association was not successfully removed.

8

Unable to add one or more Customer Resource associations.

Customer resource association was not successfully added.

9

Unable to remove one or more Resource Group associations.

Resource group association was not successfully removed.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example associates a VPDN group and DNIS/call type pair to the customer, TestCustomer, in the Cisco RPMS database:

UpdateCustomer NAME=TestCustomer ADDDNIS=DNISGroup1,speech ADDVPDN=TestVPDN 

DeleteCustomer

To delete a customer record from the Cisco RPMS database, use the DeleteCustomer command. Deleting a customer also deletes all associations to VPDN groups, resource groups and DNIS group and call type pairs for that customer.

Command Syntax

DeleteCustomer [-p port] [-id client] [-q] [-] [-h] NAME=name

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) Customer name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

System Messages

RC1 Message Description

1

Customer not found.

Customer was not found in the Cisco RPMS database.

2

Customer name invalid or missing.

Customer name contains invalid characters or was not entered. Check the syntax for this command and enter a valid value for the NAME tag.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example deletes the customer, TestCustomer, from the Cisco RPMS database:

DeleteCustomer NAME=TestCustomer

CreateDNIS

To create a DNIS record in the Cisco RPMS database, use the CreateDNIS command.

Command Syntax

CreateDNIS [-p port] [-id client] [-q] [-] [-h] NUMBER=dnis [ID=number] GROUP=dnisgroup

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NUMBER

(Required) DNIS number. The valid characters are digits 0 through 9, x and X. The maximum number of characters is 65.

ID

Reference number. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 65.

GROUP

(Required) Name of the DNIS group to which the number will belong. The valid characters are all alphabetic characters (uppercase and lowercase) and digits 0 through 9. The maximum number of characters is 32. The DNIS group specified here must already exist in the Cisco RPMS database.

System Messages

RC1 Message Description

1

DNIS Group not found.

DNIS group was not found in the Cisco RPMS database.

2

DNIS already exists.

DNIS group already exists in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example creates a DNIS number, 555-555-555, with a reference ID of 10 and associates it with the DNIS group DNISGroup1 in the Cisco RPMS database:

CreateDNIS NUMBER=555-555-555 ID=10 GROUP=DNISGroup1
 

You can use the CreateDNIS command in a script to create many DNIS numbers at once. The following example creates 50 DNIS numbers for each of 100 DNIS groups, DNISGroup1 through DNISGroup100, which already exist in the Cisco RPMS database. The DNIS numbers range from 0001001 to 0050000.

v=1
n=1000
i=1
 
while [ $v -le 100 ]
do
   while [ $i -le 50 ]
   do
   i=\Qexpr $i + 1\Q
   n=\Qexpr $n + 1\Q
   case $n in
        ????) ../CreateDNIS GROUP=DNISGroup$v NUMBER=000$n
                ;;
        ?????) ../CreateDNIS GROUP=DNISGroup$v NUMBER=00$n
               ;;
   esac   
   done
   v=\Qexpr $v + 1\Q
   i=1
done

UpdateDNIS

To update a DNIS record in the Cisco RPMS database, use the UpdateDNIS command.

Command Syntax

UpdateDNIS [-p port] [-id client] [-q] [-] [-h] NUMBER=dnis [ID=number] [GROUP=dnisgroup]

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NUMBER

(Required) Current DNIS number. The valid characters are digits 0 through 9, x and X. The maximum number of characters is 65.

ID

Reference number. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 65.

GROUP

Name of the DNIS group to which the number will belong. The valid characters are all alphabetic characters (uppercase and lowercase) and digits 0 through 9. The maximum number of characters is 32.

System Messages

RC1 Message Description

1

DNIS number does not exist in Cisco RPMS Server.

DNIS number does not exist in the Cisco RPMS database.

3

DNIS Group specified in the GROUP tag does not exist in Cisco RPMS Server.

DNIS group does not exist in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example updates the DNIS record, 555-555-555, in the Cisco RPMS database:

UpdateDNIS NUMBER=555-555-555 GROUP=DNISGroup2

DeleteDNIS

To delete a DNIS record from the Cisco RPMS database, use the DeleteDNIS command.

Command Syntax

DeleteDNIS [-p port] [-id client] [-q] [-] [-h] NUMBER=dnis

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NUMBER

(Required) DNIS number. The valid characters are digits 0 through 9, x and X. The maximum number of characters is 65.

System Messages

RC1 Message Description

1

DNIS record not found.

DNIS record was not found in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example deletes the DNIS, 555-555-555, from the Cisco RPMS database:

DeleteDNIS NUMBER=555-555-555

CreateDNISGroup

To add a DNIS group to the Cisco RPMS database, use the CreateDNISGroup command.

Command Syntax

CreateDNISGroup [-p port] [-id client] [-q] [-] [-h] NAME=name [DESC=description] [CALL=calltype]

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) DNIS group name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

DESC

DNIS group description. To use spaces within a description, enclose the description in double quotation marks. However, double quotation marks cannot appear within the description itself. All other characters are valid. The maximum number of characters is 128.

CALL

Default call type. The valid characters are all alphabetic characters (uppercase and lowercase) and digits 0 through 9.The maximum number of characters is 32. The call type specified here must already exist in the Cisco RPMS database.

System Messages

RC1 Message Description

2

DNIS Group already exists.

DNIS group already exists in the Cisco RPMS database.

3

Call type does not exist in Cisco RPMS Server.

Call type does not exist in the Cisco RPMS database.

4

Unable to retrieve Call Type.

Unable to retrieve the call type from the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example creates a DNIS group, DNISGroup1, with the default call type speech in the Cisco RPMS database:

CreateDNISGroup NAME=DNISGroup1 CALL=speech
 

You can use the CreateDNISGroup command in a script to create many DNIS groups at once. The following example creates 50 DNIS groups, DNISGroup1 through DNISGroup50, each with a default call type of speech:

i=1
while [ $i -le 50 ]
do
 
../CreateDNISGroup NAME=DNISGroup$i CALL=speech DESC="ct speech"
i=\Qexpr $i + 1\Q
done

UpdateDNISGroup

To update a DNIS group record in the Cisco RPMS database, use the UpdateDNISGroup command.

Command Syntax

UpdateDNISGroup [-p port] [-id client] [-q] [-] [-h] NAME=name [DESC=description] [CALL=calltype]

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) DNIS group name. The valid characters are all alphabetic characters (uppercase and lowercase) and digits 0 through 9. The maximum number of characters is 32.

DESC

DNIS group description. To use spaces within a description, enclose the description in double quotation marks. However, double quotation marks cannot appear within the description itself. All other characters are valid. The maximum number of characters is 128.

CALL

Default call type. The valid characters are all alphabetic characters (uppercase and lowercase) and digits 0 through 9. The maximum number of characters is 32. The call type specified here must already exist in the Cisco RPMS database.

System Messages

RC1 Message Description

1

DNIS Group not found.

DNIS group was not found in the Cisco RPMS database.

3

Call type does not exist in Cisco RPMS Server.

Call type does not exist in the Cisco RPMS database.

4

Unable to retrieve Call Type.

Unable to retrieve the call type from the Cisco RPMS database.

5

Default DNIS group cannot be updated.

Default DNIS group cannot be updated.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example updates the DNIS group record, DNISGroup1, in the Cisco RPMS database:

UpdateDNISGroup NAME=DNISGroup1 CALL=digital

DeleteDNISGroup

To delete a DNIS group record from the Cisco RPMS database, use the DeleteDNISGroup command. Deleting a DNIS group also deletes all DNIS numbers belonging to that group.

Command Syntax

DeleteDNISGroup [-p port] [-id client] [-q] [-] [-h] NAME=name

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) DNIS group name. The valid characters are all alphabetic characters (uppercase and lowercase) and digits 0 through 9. The maximum number of characters is 32.

System Messages

RC1 Message Description

1

DNIS group not found.

DNIS group was not found in the Cisco RPMS database.

3

Default DNIS group cannot be deleted.

Default DNIS group cannot be deleted from the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example deletes the DNIS group, DNISGroup1, from the Cisco RPMS database:

DeleteDNISGroup NAME=DNISGroup1

CreateDomainDNIS

To create a Domain/DNIS object and associate it with a VPDN Group, use the CreateDomainDNIS command.

Command Syntax

CreateDomainDNIS [-p port] [-id client] [-q] [-] [-h] NAME=name [DESC=description] VPDN=vpdngroup

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) Domain/DNIS number. The valid characters are all alphabetic characters (uppercase and lowercase), digits 0 through 9, percent sign (%), at sign (@), tilde (~), underscore (_), dash (-), exclamation point (!) and period (.). The maximum number of characters is 250.

DESC

Domain/DNIS description. To use spaces within a description, enclose the description in double quotation marks. However, double quotation marks cannot not appear within the description itself. All other characters are valid. The maximum number of characters is 128.

VPDN

(Required) VPDN group name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32. The VPDN group specified here must already exist in the Cisco RPMS database.

System Messages

RC1 Message Description

2

Domain/DNIS already exists.

Domain/DNIS number already exists in the Cisco RPMS database.

3

VPDN Group not found.

VPDN group name was not found in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example creates a domain/DNIS number, 555-555-555, and associates it with the VPDN group, TestVPDN, in the Cisco RPMS database:

CreateDomainDNIS NAME=555-555-555 DESC="Test DNIS" VPDN=TestVPDN

UpdateDomainDNIS

To update a domain/DNIS object in the Cisco RPMS database, use the UpdateDomainDNIS command.

Command Syntax

UpdateDomainDNIS [-p port] [-id client] [-q] [-] [-h] NAME=name [DESC=description] [VPDN=vpdngroup]

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) Domain/DNIS number. The valid characters are all alphabetic characters (uppercase and lowercase), digits 0 through 9, percent sign (%), at sign (@), tilde (~), underscore (_), dash (-), exclamation point (!) and period (.). The maximum number of characters is 250.

DESC

Domain/DNIS description. To use spaces within a description, enclose the description in double quotation marks. However, double quotation marks cannot appear within the description itself. All other characters are valid. The maximum number of characters is 128.

VPDN

VPDN group name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32. The VPDN group specified here must already exist in the Cisco RPMS database.

System Messages

RC1 Message Description

1

Domain/DNIS not found.

Domain/DNIS number was not found in the Cisco RPMS database.

3

VPDN Group not found.

VPDN group was not found in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example updates the DNIS domain object, 555-555-555, in the Cisco RPMS database:

UpdateDomainDNIS NAME=555-555-555 VPDN=TestVPDN2

DeleteDomainDNIS

To delete a domain/DNIS object from the Cisco RPMS database, use the DeleteDomainDNIS command.

Command Syntax

DeleteDomainDNIS [-p port] [-id client] [-q] [-] [-h] NAME=name

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) Domain/DNIS number. The valid characters are all alphabetic characters (uppercase and lowercase), digits 0 through 9, percent sign (%), at sign (@), tilde (~), underscore (_), dash (-), exclamation point (!) and period (.). The maximum number of characters is 250.

System Messages

RC1 Message Description

1

Domain/DNIS not found.

Domain/DNIS was not found in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example deletes the domain/DNIS, 555-555-555, from the Cisco RPMS database:

DeleteDomainDNIS NAME=555-555-555

CreateIPEndPoint

To create an IP endpoint object and add it to a VPDN group, use the CreateIPEndPoint command.

Command Syntax

CreateIPEndPoint [-p port] [-id client] [-q] [-] [-h] ENDPOINT=endpoint ENDLIMIT=endpointlimit [ENDTHLD=threshold] VPDN=vpdngroup

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

ENDPOINT

(Required) IP address. The valid characters are digits 0 through 9 and period (.). The minimum number of characters is 7; the maximum is 15. The following IP addresses are not valid endpoints: x.x.x.0, x.x.x.255, 255.255.255.255, 0.0.0.0 and 127.0.0.1, where x is any digit.

ENDLIMIT

(Required) IP endpoint limit. This tag accepts the keyword NOLIMIT, which sets the IP endpoint's limit to unlimited. The default value is 0.

ENDTHLD

Maximum sessions per IP endpoint for use with VPDN load balancing. This tag accepts the keyword DISABLED, which disables the maximum sessions. The maximum value is 99. The default value is 70.

VPDN

(Required) VPDN group name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32. The VPDN group specified here must already exist in the Cisco RPMS database.

System Messages

RC1 Message Description

1

VPDN Group not found.

VPDN group name was not found in the Cisco RPMS database.

2

IP Endpoint already exists.

IP endpoint already exists in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example creates an IP endpoint, 127.0.0.2, with a threshold of 10, no endpoint limit and associates it with a VPDN group, TestVPDN, in the Cisco RPMS database:

CreateIPEndPoint ENDPOINT=127.0.0.2 ENDLIMIT=NOLIMIT ENDTHLD=50 VPDN=TestVPDN

UpdateIPEndPoint

To update an IP endpoint object in the Cisco RPMS database, use the UpdateIPEndPoint command.

Command Syntax

UpdateIPEndPoint [-p port] [-id client] [-q] [-] [-h] ENDPOINT=endpoint [ENDLIMIT=endpointlimit] [ENDTHLD=threshold] VPDN=vpdngroup

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

ENDPOINT

(Required) IP address. The valid characters are digits 0 through 9 and period (.). The minimum number of characters is 7; the maximum is 15. The following IP addresses are not valid endpoints: x.x.x.0, x.x.x.255, 255.255.255.255, 0.0.0.0 and 127.0.0.1, where x is any digit.

ENDLIMIT

IP endpoint limit. This tag accepts the keyword NOLIMIT, which sets the IP endpoint limit's to unlimited. The default value is 0.

ENDTHLD

Maximum sessions per IP endpoint for use with VPDN load balancing. This tag accepts the keyword DISABLED, which disables the maximum sessions. The maximum value is 99. The default value is 70.

VPDN

(Required) VPDN group name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

System Messages

RC1 Message Description

1

IP Endpoint not found.

IP endpoint was not found in the Cisco RPMS database.

3

VPDN Group not found.

VPDN group was not found in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example updates the IP endpoint object, 127.0.0.2, in the Cisco RPMS database:

UpdateIPEndPoint ENDPOINT=127.0.0.2 ENDTHLD=70 VPDN=TestVPDN

DeleteIPEndPoint

To delete an IP endpoint object from the Cisco RPMS database, use the DeleteIPEndPoint command.

Command Syntax

DeleteIPEndPoint [-p port] [-id client] [-q] [-] [-h] ENDPOINT=endpoint VPDN=vpdngroup

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

ENDPOINT

(Required) IP address. The valid characters are digits 0 through 9 and period (.). The minimum number of characters is 7; the maximum is 15. The following IP addresses are not valid endpoints: x.x.x.0, x.x.x.255, 255.255.255.255, 0.0.0.0 and 127.0.0.1, where x is any digit.

VPDN

(Required) VPDN group name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

System Messages

RC1 Message Description

1

IP Endpoint not found.

IP endpoint was not found in the Cisco RPMS database.

3

VPDN Group not found.

VPDN group was not found in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example deletes the IP endpoint, 127.0.0.2, from the Cisco RPMS database:

DeleteIPEndPoint ENDPOINT=127.0.0.2 VPDN=TestVPDN

CreateResourceGroup

To add a resource group record to the Cisco RPMS database, use the CreateResourceGroup command.

Command Syntax

CreateResourceGroup [-p port] [-id client] [-q] [-] [-h] NAME=name [DESC=description]

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) Resource group name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

DESC

Resource group description. To use spaces within a description, enclose the description in double quotation marks. However, double quotation marks cannot appear within the description itself. All other characters are valid. The maximum number of characters is 128.

System Messages

RC1 Message Description

2

Resource Group already exists.

Resource group already exists in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example creates a resource group, ResourceGroup1, in the Cisco RPMS database:

CreateResourceGroup NAME=ResourceGroup1

DeleteResourceGroup

To delete a resource group record from the Cisco RPMS database, use the DeleteResourceGroup command.

Command Syntax

DeleteResourceGroup [-p port] [-id client] [-q] [-] [-h] NAME=name

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) Resource group name. The valid characters are all alphabetic characters (uppercase and lowercase) and digits 0 through 9. The maximum number of characters is 32.

System Messages

RC1 Message Description

1

Resource Group not found.

Resource group was not found in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example deletes the resource group, ResourceGroup1, from the Cisco RPMS database:

DeleteResourceGroup NAME=ResourceGroup1

CreateResourceService

To add a resource service record to the Cisco RPMS database, use the CreateResourceService command.

Command Syntax

CreateResourceService [-p port] [-id client] [-q] [-] [-h] NAME=name [DESC=description] PARAMS=parameters

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) Resource service name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

DESC

Resource service description. To use spaces within a description, enclose the description in double quotation marks. However, double quotation marks cannot appear within the description itself. All other characters are valid. The maximum number of characters is 128.

PARAMS

(Required) Service parameters. Use \n to generate a new line. The maximum number of characters is 255.

System Messages

RC1 Message Description

2

Resource Service already exists.

Resource service already exists in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example creates a resource service, ResourceService1, in the Cisco RPMS database:

CreateResourceService NAME=ResourceService1 PARAMS="modem min-speed any max-speed 57600 modulation v90 error-correction mnp4 compression none"

DeleteResourceService

To delete a resource service record from the Cisco RPMS database, use the DeleteResourceService command.

Command Syntax

DeleteResourceService [-p port] [-id client] [-q] [-] [-h] NAME=name

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) Resource service name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

System Messages

RC1 Message Description

1

Resource Service not found.

Resource service was not found in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example deletes the resource service, ResourceService1, from the Cisco RPMS database:

DeleteResourceService NAME=ResourceService1

CreateVPDN

To add a VPDN group record to the Cisco RPMS database, use the CreateVPDN command.

Command Syntax

CreateVPDN [-p port] [-id client] [-q] [-] [-h] NAME=name [DESC=description] TUNNELPROT=tprotocol TUNNELID=tunnel [L2PWD=lpasswd] [NAS=nasname] NASPWD=npasswd GATEWAY=gateway [GATEINFO=ginfo] GATEPWD=gpasswd [GROUPTHLD=vthreshold] [MAXSESS=slimit] [MAXOVL=olimit] [MAXMLP=mlplimit] [MAXLINKS=maxlinks]

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) VPDN group name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

DESC

VPDN group description. To use spaces within a description, enclose the description in double quotation marks. However, double quotation marks cannot appear within the description itself. All other characters are valid. The maximum number of characters is 128.

TUNNELPROT

(Required) Tunnel protocol. Supported protocols are l2f or l2tp.

TUNNELID

(Required) Tunnel ID number. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

L2PWD

L2TP tunnel password. The minimum number of characters is 4; the maximum is 255.

NAS

NAS name. All characters are valid except angle brackets (< >), double quotation marks (") and backslash (\). The maximum number of characters is 32.

NASPWD

(Required) NAS password. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The minimum number of characters is 4; the maximum is 255.

GATEWAY

(Required) Home gateway name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 255.

GATEINFO

VPDN group type. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

GATEPWD

(Required) Home gateway password. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The minimum number of characters is 4; the maximum is 255.

GROUPTHLD

VPDN group session threshold. This tag accepts the keyword DISABLED, which disables the VPDN group session threshold. The maximum value is 99. The default value is 70.

MAXSESS

Group session limit. This tag accepts the keyword NOLIMIT, which sets the group session limit to unlimited. The default value is 20.

MAXOVL

Group session overflow limit. This tag accepts the keyword NOLIMIT, which sets the group session overflow limit to unlimited. The default value is 25.

MAXMLP

Maximum MLP bundles limit. This tag accepts the keyword NOLIMIT, which sets the maximum MLP bundles limit to unlimited. The default value is 10.

MAXLINKS

Maximum links per bundle.

System Messages

RC1 Message Description

2

VPDN Group already exists.

VPDN group already exists in the Cisco RPMS database.

3

Invalid tunnel protocol tag. L2TP and L2F supported.

Invalid tunnel protocol was entered. Use either L2TP or L2F.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example creates a VPDN group, TestVPDN, in the Cisco RPMS database:

CreateVPDN NAME=TestVPDN TUNNELPROT=12f TUNNELID=MyTunnel NASPWD=MyNasPwd GATEWAY=MyGateway GATEPWD=MyGatePwd

UpdateVPDN

To update a VPDN group record in the Cisco RPMS database, use the UpdateVPDN command.

Command Syntax

UpdateVPDN [-p port] [-id client] [-q] [-] [-h] NAME=name [DESC=description] [TUNNELPROT=tprotocol] [TUNNELID=tunnel] [L2PWD=lpasswd] [NAS=nasname] [NASPWD=npasswd] [GATEWAY=gateway] [GATEINFO=ginfo] [GATEPWD=gpasswd] [GROUPTHLD=vthreshold] [MAXSESS=slimit] [MAXOVL=olimit] [MAXMLP=mlplimit] [MAXLINKS=maxlinks]

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) VPDN group name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

DESC

VPDN group description. To use spaces within a description, enclose the description in double quotation marks. However, double quotation marks cannot appear within the description itself. All other characters are valid. The maximum number of characters is 128.

TUNNELPROT

Tunnel protocol. Supported protocols are l2f or l2tp.

TUNNELID

Tunnel ID number. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

L2PWD

L2TP tunnel password. The minimum number of characters is 4; the maximum is 255.

NAS

NAS name. All characters are valid except angle brackets (< >), double quotation marks (") and backslash (\). The maximum number of characters is 32.

NASPWD

NAS password. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The minimum number of characters is 4; the maximum is 255.

GATEWAY

Home gateway name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 255.

GATEINFO

VPDN group type. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

GATEPWD

Home gateway password. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The minimum number of characters is 4; the maximum is 255.

GROUPTHLD

VPDN group session threshold. This tag accepts the keyword DISABLED, which disables the VPDN group session threshold. The maximum value is 99. The default value is 70.

MAXSESS

Group session limit. This tag accepts the keyword NOLIMIT, which sets the group session limit to unlimited. The default value is 20.

MAXOVL

Group session overflow limit. This tag accepts the keyword NOLIMIT, which sets the group session overflow limit to unlimited. The default value is 25.

MAXMLP

Maximum MLP bundles limit. This tag accepts the keyword NOLIMIT, which sets the maximum MLP bundles limit to unlimited. The default value is 10.

MAXLINKS

Maximum links per bundle.

System Messages

RC1 Message Description

1

VPDN Group not found.

VPDN group was not found in the Cisco RPMS database.

3

Invalid tunnel protocol tag. L2TP and L2F supported.

Invalid tunnel protocol was entered. Use either L2TP or L2F.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example updates the VPDN group record, TestVPDN, in the Cisco RPMS database:

UpdateVPDN NAME=TestVPDN NASPWD=MyOtherNasPwd

DeleteVPDN

To delete a VPDN group record from the Cisco RPMS database, use the DeleteVPDN command. Deleting a VPDN group also deletes the IP endpoints and domain/DNISes associated with the group.

Command Syntax

DeleteVPDN [-p port] [-id client] [-q] [-] [-h] NAME=name

Syntax Description

The following switches can appear before or after tag-value pairs on the command-line.
Switch Command Type Description

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 41.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-

standard input

(Optional) Accept additional input from standard input. After this switch is entered, no other switches can be entered. To exit input mode, press Return twice.

-h

help

(Optional) Displays help for this command.

Tag Description

NAME

(Required) VPDN group name. All characters are valid except angle brackets (< >), asterisk (*), equal sign (=) and double quotation marks ("). The maximum number of characters is 32.

System Messages

RC1 Message Description

1

VPDN Group not found.

VPDN group was not found in the Cisco RPMS database.

64

Invalid Command.

Invalid command was entered. Check the spelling of the command and try it again.

65

Specified command is not supported.

Unsupported command was entered. Only the commands described in this chapter are supported.

66

Command contains Invalid Tags.

Invalid tag was entered. Check the syntax for this command and eliminate the unsupported tag.

67

Missing one or more required Tags.

Required tag was not entered. Check the syntax for this command and enter all required tags.

68

Connection to Cisco RPMS failed.

Connection to the Cisco RPMS database server failed.

69

Internal Database Error.

Internal database error occurred.

70

Internal CLI command error.

Internal CLI error occurred.

71

Unknown CLI error.

Unknown CLI error occurred.

72

Invalid command. Command contained no arguments.

No arguments were specified. Check the syntax for this command and enter all required arguments.

1RC = Return code.

Example

The following example deletes the VPDN group record, TestVPDN, from the Cisco RPMS database:

DeleteVPDN NAME=TestVPDN

CLIBatcher

To process a file of CLI commands in batch mode or to process CLI commands from standard input, use the CLIBatcher command.

CLIBatcher improves performance by establishing a single RMI connection to the Cisco RPMS and processing commands in parallel (Cisco RPMS still performs transactions sequentially).

In addition to processing commands in batch mode, CLIBatcher can be used to individually enter commands. Although this is not much different than entering commands at the UNIX prompt, CLIBatcher improves performance by only opening one connection to the Cisco RPMS.


Note Because CLIBatcher is a batch input application, only the success or failure or the operation is reported. To view which commands failed, refer to the log file.
If a command fails, it can cause additional commands to fail (domino effect).

Command Syntax

CLIBatcher [-f command_file] [-l log_file] [-p port] [-c client] [-T thread_count] [-v] [-t] [-h] [-q]

Syntax Description

Switch Command Type Description

-f

command file

(Optional) Name of the file containing CLI commands. If this switch is not provided, command input will be taken from standard input. Within the command file, each command can only span one line.

-l

log file

(Optional) Name of a file to which to log messages. If this switch is not provided, messages will be logged to standard output.

-p

port

(Optional) Cisco RPMS server port number with which to communicate. Required if connecting to another server. If no port number is provided in the command-line, the command will search for the DBRMIPort key value in the System section of the common configuration file ($BASEDIR/config/common.cnf). If no key value is found there, the command uses 1100.

-id

clientID

(Optional) Client's identification number. You can assign a unique number that can be used to differentiate multiple CLIs accessing the Cisco RPMS database at any given time. The default is 1.

-T

thread count

(Optional) Creates a pool of threads. Each thread provides a parallel path of execution. The default it 3. Increasing the number of threads of execution can increase batch time.

-q

suppress output

(Optional) Prevents error and success messages from appearing on the screen.

Note If you use this option, you will not see error messages that can affect the execution of subsequent commands.

-v

verify mode

(Optional) Validates command syntax, without executing the command. Does not perform validation of tag values that requires access to the Cisco RPMS database.

-t

timed mode

(Optional) Displays the time to execute each command and the total time to execute all the commands.

-h

help

(Optional) Displays help for this command.

Example

The following example executes the file of CLI commands, myfile, in batch mode and logs messages to the file, myfile.log:

CLIBatcher -f myfile -l myfile.log
 

The input file, myfile, contains the following commands which create a VPDN group, VPDNGroup1, a DNIS group, DNISGroup1, and a resource group, ResourceGroup1. A customer, TestCustomer, is then created and VPDNGroup1, DNISGroup1 and ResourceGroup1 are associated to it.

CreateVPDN NAME=VPDNGroup1 TUNNELID=MyTunnel NASPWD=MyNasPwd GATEWAY=MyGateway GATEPWD=MyGatewayPwd TUNNELPROT=l2f
CreateDNISGroup NAME=DNISGroup1
CreateDNIS NUMBER=5555555555 GROUP=DNISGroup1
CreateDomainDNIS NAME=cisco.com VPDN=VPDNGroup1
CreateIPEndPoint ENDPOINT=127.0.0.2 ENDLIMIT=NOLIMIT VPDN=VPDNGroup1
CreateResourceGroup NAME=ResourceGroup1
CreateResourceService NAME=ResourceService1 PARAMS="modem min-speed any max-speed 57600 modulation v90 error-correction mnp4 compression none"
CreateCustomer NAME=TestCustomer CALLTREAT=no-answer ADDDNIS=DNISGroup1,speech ADDVPDN=VPDNGroup1 ADDRES=ResourceGroup1,speech,ResourceService1
 

In this example, some commands continue on to the next line so that they can be displayed in their entirety. However, in a real input file, a single command can only span one line.

The log file, myfile.log, contains the following messages:

VPDN Group VPDNGroup1 successfully created.
DNIS Group DNISGroup1 successfully created.
DNIS number 5555555555 successfully created.
VPDN Domain/DNIS cisco.com successfully created.
VPDN IP Endpoint 127.0.0.2 successfully created.
Resource Group ResourceGroup1 successfully created.
Resource Service ResourceService1 successfully created.
Customer TestCustomer successfully Added.


hometocprevnextglossaryfeedbacksearchhelp
Posted: Thu Aug 31 07:35:18 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.