Table of Contents

Introduction
Command Syntax Elements
Session Management Commands
Transaction Management Commands
Service Object Commands

Attribute Array

General Attributes
List Specific Attributes
New Transaction Attributes
Miscellaneous Attributes

ATM Virtual Links
NNI Resiliency Commands
UNI Resiliency Commands
Configuration Object Commands

Variables
Termination Variables

Script Language Reference

Introduction

This section describes the script commands, and environment variables, and indicates the locations of the system log files.

Command Syntax Elements

This section defines the elements of the Script Language command syntax that are used in this chapter.

AttArray	An array of AttValueAssertions one per attribute of the object, as defined in the object's OAF.
AttLabel	The external label associated with an attribute. This is the text that accompanies the attribute field in the GUI.
AttLabelArray	An AttArray in which the value part of each AttValueAssertion contains an AttLabel.
AttModeArray	An AttArray in which the value part of each AttValueAssertion contains the mode of the attribute's field in the GUI and can be one of READONLY or READWRITE.
AttName	The name of an attribute as specified in the object's OAF.
AttValue	The value of an attribute of the object.
AttValueAssertion	A description of an object attribute in the form AttName=AttValue. If the AttValue contains a space, then AttName=AttValue must be enclosed in quotes as "AttName=AttValue". Spaces must not surround the =.
Class	The class of the target object (for example, XXNDNode, Site, ...). Comes from the "Object Class" line in the OAF.
ClassTitle	The external label associated with an object.
Criteria	The search criteria which apply to this object class. The criteria can be supplied as either a list of AttValueAssertions separated by "/", or as an array of AttValueAssertions passed by name. The default value for a criterion is "*". The minimum value for the list of AttValueAssertion s is "/", and for the array of AttValueAssertion s is an empty array.
DebugLevel	An integer greater than or equal to 0 specifying the debug level.
Descr	The brief description of the Transaction.
Display	Display name in the form HostName:0.0, referring to the session of the GUI running on that display.
FirstNum	A positive integer specifying the first object to be returned by a java SOClass list command.
ItemNum	An integer (in the range 1..NumItems) identifying one object in the current list.
ListId	A unique identifier for an object list.
MaxNum	A positive integer specifying the maximum number of objects returned by a java SOClass list command.
MD	The TD value of the Transaction.
NumItems	An integer specifying the number of items which matched the selection criteria.
OId	A unique identifier for the instance of an object (in the form Class:Num).
ParserClass	The special class needed to read attributes of the Service object.
SessId	A unique numeric identifier for the session.
SessOId	A unique identifier for the session in the form "SYssnSession:SessId".
SiteName	The name of the site, as displayed in the Site list viewer.
SO	The attributes of the Service object in the format determined by argument AVformatter.
SOClass	The Service object class. For example, the Frame Relay Service object class is com.syndesis.frrm.RFsvServiceObject.
SOComponents	A list of components associated with the Service object. The list is displayed in the format determined by argument AVformatter.
SOList	A list of zero or more SO s.
SOProf	The attributes and modes of the Service profile in the format determined by argument AVformatter.
TransactionNum	A unique numeric identifier for the Transaction.
URNum	A unique numeric identifier for the Upload Request.
UROId	A unique identifier for the Upload Request.
VM	Keyword, referring to the session of the GUI running on the display given by $DISPLAY. This is always the default when a session is not specified.
VPN	The VPN value of the Transaction.

Session Management Commands

Script gives access to session object:

AVtm findCR
Calling Sequence:	AVtm findCR [SessId | Display |VM]
Result Arguments:	TransactionNum
Description:	Returns the current Transaction number to stdout of the indicated session, or zero if none. If no session argument is given, the environment variable $DISPLAY is used.
Example:	TRNUM=$(AVtm findCR)

AVtm findVMSession
Calling Sequence:	AVtm findVMSession [Display | VM]
Result Arguments:	SessId
Description:	Returns the session ID to stdout of the interactive session associated with the given display, or zero if none. If no session argument is given, the environment variable $DISPLAY is used.
Example:	SESSID=$(AVtm findVMSession)

AVtm wait
Calling Sequence:	AVtm wait
Result Arguments:	SessId
Description:	Creates a new session and returns its id to stdout. This command waits for the SIGTERM signal before terminating (and destroying the session). The AVtm wait command is an alternative to running npsinit with NPSNEWSESSION when sessions need to be managed (npsinit doesn't give as much control). If your main loop is not ksh (because terminating ksh would kill npsinit), or you need multiple sessions, or have no need for nps commands, then the AVtm wait command is the logical choice.
Example:	AVtm wait |& read -p SESSID Termination codes are: 0 - Command successful 1 - Command successful

Code	Description
0	Command successful.
1	Command unsuccessful.

Transaction Management Commands

Script gives access to Transaction objects.

AVcr Abandon
Calling Sequence:	AVcr abandon TransactionNum [SessId | Display | VM]
Result Arguments:	None
Description:	Abandons the Transaction, in the indicated session. If no session argument is given, the environment variable $DISPLAY is used. This command waits until the Transaction either succeeds to the Applied state or fails to the Abandoned state.
Example:	AVcr abandon $TRNUM

AVcr Abort
Calling sequence:	AVcr abort TransactionNum [SessId | Display | VM]
Result Arguments:	None
Description:	Aborts the Scheduled Transaction, in the indicated session. If no session argument is given, the environment variable $DISPLAY is used. This command does not wait for completion.
Example:	AVcr abort $TRNUM

AVcr apply
Calling Sequence	AVcr apply TransactionNum [SessId | Display | VM]
Result Arguments:	None
Description:	Applies the Transaction to the network, in the indicated session. If no session argument is given, the environment variable $DISPLAY is used. This command wait until the Transaction either succeeds to the Applied state or fails to the Abandoned state.
Example:	AVcr apply $TRNUM

AVcr close
Calling Sequence:	AVcr close TransactionNum [SessId | Display | VM]
Result Arguments:	None
Description:	Closes a previously opened Transaction, in the indicated session. If no session argument is given, the environment variable $DISPLAY is used.
Example:	AVcr close $TRUM

AVcr create
Calling Sequence:	AVcr create [SessId | Display | VM] [descr=Descr] [md=MD] [vpn=VPN]
Result Arguments:	TransactionNum
Description:	Creates a new Transaction but does not open it, in the indicated session. If no session argument is given, the environment variable $DISPLAY is used. This command returns the Transaction number to stdout.
Example:	TRNUM=$(AVcr create "descr=Creating profiles")

AVcr delete
Calling Sequence:	AVcr delete TransactionNum [SessId | Display | VM]
Result Arguments:	None
Description:	Deletes the Transaction and all associated files, in the indicated session. It deletes the Transaction by closing it if it is open or abandoning it if it is in the Ready state. Delete is possible from the Ready and Current states. If no session argumnet is given, the environment variable $DISPLAY is used.
Example:	AVcr delete $TRNUM

AVcr modify
Calling Sequence:	AVcr modify TransactionNum [SessId | Display | VM] [descr=Descr] [md=MD] [vpn=VPN]
Result Arguments:	None
Description:	Modifies the Brief Description, MD, and/or VPN of the given Transaction, in the indicated session. If no session argument is given, the environment variable $DISPLAY is used.
Example:	AVcr modify $TRNUM "descr=Creating profiles: Gold, Silver, Bronze"

AVcr open
Calling Sequence:	AVcr open TransactionNum [SessId | Display | VM]
Result Arguments:	None
Description:	Opens a Transaction, in the indicated session. If no session argument is given, the environment variable $DISPLAY is used.
Example:	AVcr open $TRNUM

AVcr schedule
Calling Sequence:	AVcr schedule TransactionNum [SessId | Display | VM] scheduletime="yyy/mm/dd hh:mm" AVcr schedule TransactionNum [SessId | Display | VM] scheduletime="now"
Result Arguments:	None.
Description:	Schedules a Transaction using a scheduletime in the indicated session. The transaction will remain in the Scheduled state until the scheduletime is current, then the Transaction will be scheduled immediately in the background. If no session argument is given, the environment variable $DISPLAY is used. This command does not wait for completion.
Example:	AVcr schedule $TRNUM scheduletime="1999/12/01 02:14"

AVcr start
Calling sequence:	AVcr start [SessId | Display | VM] [descr=Descr] [md=MD] [vpn=VPN]
Result arguments:	TransactionNum
Description:	Starts a new Transaction with the given Brief Description, MD, and VPN, in the indicated session. If no session argument is given, the environment variable $DISPLAY is used. This command creates a new Transaction, opens it and then returns the Transaction number to stdout.
Example:	TRNUM=$(AVcr start "descr=Creating profiles") Termination codes are: 0 - Command successful 1 - Command unsuccessful. Wrong number of arguments, or      incorrectly given. 2 - Command unsuccessful. Transaction state error. Tried to find or put      a Transaction into a specific state that could not be dealt with. 3 - Command unsuccessful. Any other error (not termination codes 1, 2      or 4). 4 - Command unsuccessful, attempted to rollback, then rollback failed.

Code	Description
0	Command successful.
1	Command unsuccessful. Wrong number of arguments, or incorrectly given.
2	Command unsuccessful. Transaction state error. Tried to find or put a Transaction into a specific state that could not be dealt with.
3	Command unsuccessful. Any other error (not termination codes 1,2, or 4)
4	Command unsuccessful, attempted to rollback, then rollback failed.

Service Object Commands

Service Object	SOClass Argument
ATM Service Object	com.syndesis.frrm.RAsvServiceObject
Frame Relay Service Object	com.syndesis.frrm.RFsvServiceObject
Frame Relay-ATM Interworking Service Object	com.syndesis.frrm.RFixsvServiceObject
SGT Service Object	com.syndesis.gtfti.PVCsvServiceObject
CBR Service Object	com.syndesis.scb.SCB1CBR
CBR-ATM Interworking Service Object	com.syndesis.scb.SCB3CES

Termination codes are:

Code	Description
0	Command successful. The Transaction can be or has been applied.
1	Command unsuccessful. The Transaction has been closed and abandoned.
2	Command unsuccessful, attempted to rollback, then rollback failed or attempt to output exception failed. The state of the Transaction is indeterminate.
30	Command unsuccessful. System is not up.
31	Command unsuccessful. System shut down during processing.
Other non-zero	Command unsuccessful. Any other error.

Attribute Array

The AttArray consists of AttName=AttValue pairs. The attribute name may either be an attribute of the object's GUI or OAF, or a standard Cisco Provisioning Center object attribute as described here.

General Attributes

The following attributes are available for all java SOClass commands.

AVcr=AttValue
Description:	The AVcr attribute specifies the Transaction in which the Script Language command is called.
AttValue:	TransactionNum	Specified Transaction: CPC works within the Transaction specified by the given number. If that Transaction is already open in the session then CPC uses it. If that Transaction is open in another session or another Transaction is open in the current session then CPC throws an error. If no Transaction is open, then CPC opens the specified Transaction for the session.
	atomic	Atomic Transaction: CPC creates and opens a new Transaction, and throws an error if a Transaction is already open in the session. This is useful if the upper level application is passing work between operator sessions, where the operator might unexpectedly open another Transaction.
	auto	Automatic Transaction: CPC uses the Transaction open in the current session if there is one, and automatically creates and opens one if not.
	current	Current Transaction: CPC uses the Transaction open in the current session if there is one, or none at all. If the Script Language command requires an open Transaction then not having one causes an error.
	none	No Transaction: CPC checks that there is no Transaction open in the current session, and throws an error otherwise. If the Script Language command requires an open Transaction then not having one also causes an error.
	open	Open Transaction: CPC checks that there is a Transaction open in the current session, and throws an error if not. This is useful if the upper level application is passing work between operator sessions, where the operator might unexpectedly close the Transaction.
Default:	none

AVformatter=AttValue
Description:	The AVformatter attribute specifies the format of the output (both objects and errors/exceptions). If an exception is generated with any of these formatters, then the Script Language command failed and any object output is meaningless. Note that attribute modes are displayed as name-value pairs where the name is the attribute name prefixed with "~" and the value is the mode of that attribute.
AttValue:	com.syndesis.activator.DefaultFormatter	Default Formatter: This is the default formatter used to output both objects and exceptions to stdout. It is useful for debugging using the command line interface, as the output is produced in a brief yet semi-readable form. Each line describes a single object using the standard Java toString() method. Objects appear as follows, a single object per line: AttName=AttValue where AttName=AttValue is repeated once for each attribute mode (when requested). The name-value pairs do not appear in any particular order. Note that attribute values with special characters are not escaped in any way, making the output from this formatter unsuitable for use as input to another program. If the output is to be read by another program, use the Simple Formatter or a custom formatter.
	com.syndesis.activator.SerialFormatter	Serial Formatter: This formatter produces output as Java serialized objects so that they can be reinstantiated in a Java application. This formatter serializes both the objects and exceptions.
	com.syndesis.activator.SimpleFormatter	Simple Formatter: This is the normal formatter for use within a flow-through application. This formatter produces output that can easily be processed by the invoking program. This formatter buffers the data so as to produce either an object or an exception--not both. If the command succeeds you get the object output, and if the command fails you get the exception. Objects appear as follows, a single object per line: AttName=AttValue where AttName=AttValue is repeated once for each attribute and once for each attribute mode (when requested). The name-value pairs do not appear in any particular order. The attribute values are enclosed in double quotes, with embedded double quotes and backslashes escaped by preceding those characters with a backslash. All name-value pairs are blank separated. Exceptions appear as follows, one exception per line: Number Description where Number is a unique number which identifies the exception, and Description gives a textual description of the exception.
	com.syndesis.activator.TNDetailsFormatter	TN Details Formatter: This is a special purpose formatter specifically for the java SOClass details command of transmission network oriented Services. This formatter outputs both the objects and exceptions to stdout. For the FR Service, ATM Service and FR-ATM Interworking Service, this formatter with the java SOClass details command displays an alternating list of Network Connections and Links. The items are sorted to show the chain of objects from the A endpoint to the Z endpoint of the composite Network Connection. Each component is displayed one to a line. All fields are blank separated. The list is: NCInfo [LCInfo NCInfo] where NCInfo describes a Network Connection component and LCInfo describes a Link Connection component. Each NCInfo is of the form: NCOId Network ANode ALPort ZNode ZLPort where: NCOId is the Network Connection's object id, Network describes the containing Network, ANode describes the A endpoint Node, ALPort describes the A endpoint Logical Port, ZNode describes the Z endpoint Node, ZLPort describes the Z endpoint Logical Port. Each LCInfo is of the form: LCOId where: LCOId is the Link Connection's object id. The Network, ANode, ALPort, ZNode, and ZLPort are each displayed as Name OId (the object's name and object id). The Name is enclosed in double quotes so that the results may be interpreted programmatically. Embedded double quotes are not handled, so a custom formatter must be used if such names exist. Null object ids are displayed as a pair of double quotes.
Default:	com.syndesis.activator.DefaultFormatter

AVsession=AttValue
Description:	The AVsession attribute specifies the session in which the Script Language command is called.
AttValue:	SessId	Specified Session: CPC uses the session specified by the session number. This is useful when running without an interactive session or when an umbrella manager wants a CPC daemon to work in the context of more than one operator (many displays).
	VM	GUI Session: CPC uses the session of the interactive session.
Default:	VM

List Specific Attributes

The following attributes are defined for the java SOClass list command or java SOClass listProfile command.

SOFirst=FirstNum
Description:	First Object Number: The number of the first object to be returned by the java SOClass list or java SOClass list Profile command. The first object is numbered 1, the second is numbered2, and so on.
Default	1

SOMax=MaxNum
Description:	Maximum Objects Returned: Maximum number of objects to be returned by the java SOClass list or java SOClass listProfile command, starting at the SOFirst object to the (SOFirst + SOMax - 1) object.
Default	100

New Transaction Attributes

The following attributes are used by CPC when it needs to create a new Transaction. This may occur when using AVcr=atomic or AVcr=auto.

AVdescription=Descr
Description:	Brief Description of the Transaction: If a Transaction is created by CPC, the Transaction is created with the given description.
Default	""

AVmd=MD
Description:	MD of the Transaction: If a Transaction is created by CPC, the Transaction is created with the given MD.
Default	""

AVschedule=<yyyy/mm/dd hh:mm>
Description:	Scheduletime of the Transaction: If a Transaction is created by Cisco Provisioning Center, it is created with the given Scheduletime in <yyyy/mm/dd hh:mm> format.
Default	""

AVschedule=now
Description:	Scheduletime of the Transaction: If a Transaction is created by Cisco Provisioning Center, it is created with the given Scheduletime in <yyyy/mm/dd hh:mm> format.
Default	""

AVvpn=VPN
Description:	VPN of the Transaction: If a Transaction is created by Cisco Provisioning Center, the Transaction is created with the given VPN.
Default:	""

Miscellaneous Attributes

The following attributes are available for all java SOClass commands

AVdebug=DebugLevel
Description:	Debug Level: Debug level for CPC classes. This number is an integer with a value of zero for no debug information, and positive values for debug information. Larger positive values produce greater levels of detail. Debug information is written directly to stderr.
Default	0 (no debug information)

AVparser=ParserClass
Description:	Parser Class: Name of the class used to parse attributes that cannot be specified through the command line.
Default	None

ATM Virtual Links

Use the following commands to create, modify and delete ATM Virtual Links.

java createVLinkService
Calling Sequence:	java com.syndesis.activator.Activator com.syndesis.frrm.SATvVLink create
Description:	Creates an ATM Virtual Link
Example:	[createVLinkService name=UA_VLINK_1001 srprofile.sy_profname=Default \ type=VP qos=CBR recoveryprio=5 \ a_tp=$A_node/$A_1port az_tdtype=CBR.1 az_scr=10 az_pcr=10 \ z_tp=$Z_node/$Z_1port za_tdtype=CBR.1 za_scr=10 za_pcr=10 \ az_mbs=30 az_cdv=30 az_cdvt=30 \ za_mbs=30 za_cdvt=30 srmanaged=TRUE \ AVdescription=$testId:::$testDesc1]

java modifyVLinkService
Calling Sequence:	java com.syndesis.activator.Activator com.syndesis.frrm.SATvVLink modify
Description:	Modified an ATM Virtual Link.

java deleteVLinkService
Calling Sequence:	java com.syndesis.activator.Activator com.syndesis.frrm.SATvVLink delete
Description:	Modified an ATM Virtual Link.
Example:	delete VLinkService sy_objectid=<SOid>

NNI Resiliency Commands

Script gives access to NNI resiliency commands on NNI links.

.

java ServiceUtility linkfail
Calling Sequence:	java com.syndesis.resiliency.ServiceUtility linkfail OId
Result Arguments:	None
Description:	Re-threads the circuits running over the specified failed link. This command returns when it either succeeds or fails.
Example:	java com.syndesis.resiliency.ServiceUtility linkfail \ $LKID

java ServiceUtility linkrecover
Calling Sequence:	java com.syndesis.resiliency.ServiceUtility linkrecover Old
Result Arguments:	None
Description:	Restores the specified recovered link. This command returns when it either succeeds or fails.
Example:	java com.syndesis.resiliency.ServiceUtility linkrecover \ $LKID

java ServiceUtility linkbalance
Calling Sequence:	java com.syndesis.resiliency.ServiceUtility linkbalance OId
Result Arguments:	None
Description:	Re-balances the load across links in the same group as the indicated link. This command returns when it either succeeds or fails.
Example:	java com.syndesis.resiliency.ServiceUtility linkbalance \$LKID

Code	Description
0	Command successful.
Non-zero	Command unsuccessful.

java ServiceUtility linkbalance
Calling Sequence:	java com.syndesis.resiliency.ServiceUtility linkbalance Old
Result Arguments:	None
Description:	Re-balances the load across links in the same group as the indicated link. This command returns when it either succeeds or fails.
Example:	java com.syndesis.resiliency.ServiceUtility linkbalance \     $LKID Termination codes are: 0 - Command successful None-zero - Command unsuccessful

UNI Resiliency Commands

Script give access to UNI resiliency commands on UNI links:

java ServiceUtility unifail
Calling Sequence:	java com.syndesis.resiliency.ServiceUtility unifail Old
Result Argument:	None
Description:	Moves PVCs from foreground logical port to the backup logical port when a foreground logical port fails. This command returns when it either succeeds or fails.
Example:	java com.syndesis.resiliency.ServiceUtility unifail \ $OPER $LPNAME Rformatter SimpleFormatte

java ServiceUtility unirecover
Calling Sequence:	java com.syndesis.resiliency.ServiceUtility unirecover Old
Result Arguments:	None
Description:	Moves PVCs back from the backup logical port to the foreground logical port when a foreground logical port recovers. This command returns when it either succeeds or fails.
Example:	java com.syndesis.resiliency.ServiceUtility unirecover \ $OPER $LPNAME SimpleFormatte

Configuration Object Commands

Script gives access to all configuration objects. In this section an argument which is passed by name is defined with the notation N after the argument. An argument which is underlined is modified by the command--arguments are returned in this fashion

.

. npsinit
Calling Sequence:	. npsinit
Description:	Initializes the CPC configuration object interpreter. Must precede all other nps commands.
Example:	. $CCP_BIN/npsinit

npsinit
Calling Sequence:	npsinit
Description:	Initializes the Cisco Provisioning Center configuration object interpreter. Must precede all other nps commands. npsinit can either create a new session (see variable NPSNEWSESSION) or bind to an existing session (see variable SYSESSIONID).
Example:	$CCP BIN/npsinit

nps create
Calling Sequence:	nps create Class AttArray N Old N
Description:	Creates an add pending version of the new object in the database. If creating a new configuration object and AttArray specifies the associated profile (with attribute srprofile), then the profile is always applied first no matter where it appears in the attribute array (to ensure that other specified attributes are not overridden). A Transaction must already be opened. Note that this command returns a warning when trying to set read-only attributes (return code 17028, command successful but warning trying to set read-only attributes failed.).
Example:	nps create XXPVPVCProf ATTS PID

nps delete
Calling Sequence:	nps delete OId
Description:	Saves a delete pending version of the configuration object in the database. A Transaction must already be opened.
Example:	nps delete $PID

nps error
Calling Sequence:	nps error
Description:	Checks status of the last nps command. Writes a message (to stderr) if it was in error, and stops the flow-through application.
Example:	nps error

nps getlabels
Calling Sequence:	nps getlabels OId AttLabelArray*
Description:	Returns the attribute labels of the specified object.
Example:	nps getlabels $NDID ALABELS

nps gettitle
Calling Sequence:	nps gettitle OId ClassN ClassTitleN
Description:	Returns the class and title of the specified object. The element class appears in the "Object Class" line of the corresponding OAF. The title appears in the "Object Title" line of the corresponding OAF.
Example:	nps gettitle $NDID CLASS NTITLE

nps insert
Calling Sequence:	nps insert AttArrayN AttName AttValue
Description:	Sets the value of an attribute in the attribute array, overwriting the previous value (if present).
Example:	nps insert ATTS inseam 34

nps list
Calling Sequence:	nps list Class Criteria
Description:	Invokes the GUI to display the list viewer for the specified object class. Before this command can be executed, the flow-through application must be running in the same session as the GUI. The GUI executes an automatic"Get List" function using the supplied search criteria. When this command has been executed, the GUI and flow-through application can operate independently: control returns to the flow-through application immediately, while the user can invoke the GUI functions on the displayed viewer.
Example:	nps list XXPVPVC domain=Eastern/vpn=WestBank

nnps modify
Calling Sequence:	nps modify OId AttArrayN
Description:	Modifies an object with the specified attributes in the Cisco Provisioning Center database. If modifying a configuration object and AttArray specifies the associated profile (with attribute srprofile), then the profile is always applied first no matter where it appears in the attribute array (to ensure that other specified attributes are not overwridden). Saves in the database a modify pending version of the object unless the object has been created within the same Transaction, in which case the command simply modifies the existing add pending version. A Transaction must be already opened. Note that this command returns a warning when trying to set read-only attributes (return code 17028, command successful but warning trying to set read-only attributes failed).
Example:	nps modify $PID ATTS

nps modifymodes
Calling Sequence:	nps modifymodes OId AttModeArrayN
Description:	Modifies a profile's attribute modes with the specified modes in the database. OId must specify a profile.
Example:	nps modifymodes $PROFID MODES

nps read
Calling Sequence:	nps read OId AttArrayN
Description:	Reads all the attributes of the specified object.
Example:	nps read $NDID ATTS

nps readitem
Calling Sequence:	nps readitem ListId ItemNum OIdN AttArrayN
Description:	Reads an item from a previously-initiated nps selectmany or nps selectallversions, and returns its OId and its selector attributes. The resulting OId can be used in a subsequent nps read command.
Example:	nps readitem $LISTID $ITEM NDID ATTS

nps readmodes
Calling Sequence:	nps readmodes OId AttModeArrayN
Description:	Reads all the attribute modes of the specified object.
Example:	nps readmodes $PROFID MODES

nps reselectmany
Calling Sequence:	nps reselectmany ListId NumItemsN CriteriaN
Description:	Rebuilds an existing list of objects, by recalculating the list using the criteria which were specified when the list was originally created (from a previous nps selectmany). The resulting items are saved for interrogation by subsequent nps readitem requests. The command returns the number of items in the list and the criteria.
Example:	nps reselectmany $LISTID NUMITEMS CRITERIA

nps retrieve
Calling Sequence:	nps retrieve AttArrayN AttName AttValueN
Description:	Extracts the attribute identified by the name AttName from the attribute array AttArray. Can be used to extract the value, label or mode of an attribute.
Example:	nps retrieve ATTS inseam INSEAM

nps selectallversions
Calling Sequence:	nps selectallversions OId ListIdN NumItemsN
Description:	Creates a list of objects with the given object id. Both pending and current versions are returned when they exist. The resulting items are saved for interrogation by subsequent nps readitem requests. The "sy_version" attribute which is returned by nps readitem is the version. The command returns the number of items in the list and a list id to be used by nps readitem.
Example:	nps selectallversions $PID LISTID NUMITEMS

nps selectmany
Calling sequence:	nps selectmany Class Criteria ListIdN NumItemsN
Description:	Creates a list of objects of class Class matching the specified criteria. If no criteria are required (all criteria wildcarded) then a single "/" must be supplied. The resulting items are saved for interrogation by subsequent nps readitem requests. The command returns the number of items in the list and a list id to be used by nps readitem. The Class supplied may be a subclass or may be a base class, in which case the resultant list contains entries for all classes that match the Criteria.
Example:	nps selectmany XXNDNode domain=Western/vpn=mybank \ LISTID NUMITEMS

nps selectone
Calling Sequence:	nps selectone Class Criteria OIdN
Description:	Returns the object id of the single object of class Class matching the criteria. Returns an error if the criteria do not uniquely identify one object. The Class supplied may be a subclass or may be a base class, in which case the resultant list contains entries for all classes that match the Criteria.
Example:	nps selectone XXNDNode domain=Western/vpn=private NDID

nps split
Calling Sequence:	nps split "AttValueAssertion" AttNameN AttValueN
Description:	Splits the attribute value assertion into its component parts--an attribute name and an attribute value. The attribute value assertion should be placed within quotes.
Example:	nps split "$ATTR" NAME VALUE

nps stop
Calling Sequence:	nps stop
Description:	Terminates the Cisco Provisioning Center configuration object interpreter. When ksh is terminated, it automatically invokes this command, so it does not need to be included explicitly.
Example:	nps stop

nps trace
Calling Sequence:	nps trace Text
Description:	Writes the supplied text to the trace log. This command has no effect if tracing is not enabled.
Example:	nps trace "starting main loop"

nps view
Calling Sequence:	nps view OId
Description:	Invokes the GUI to display the object viewer for the specified object. Before this command can be executed, the flow-through application must be running in the same session as the GUI. When this command has been executed, the GUI and flow-through application can operate independently: control returns to the flow-through application immediately, while the user can invoke GUI functions on the displayed viewer.
Example:	nps view $NDID

nps upload
Calling Sequence:	nps upload OId AttArrayN UROId N
Description:	Uploads the specified object and its contained objects into the CPC database, given the upload information in AttArray. This command returns only when the Upload Request has finished processing. If an error occurs, the UROId is set to "".
Example:	nps upload $NDID ATTS URID

nps upload
Calling sequence:	nps upload ListId AttArray N UROId N
Description:	Uploads the list of specified objects and their contained objects into the CPC database, given the upload information in AttArray. This command returns only when the Upload Request has finished processing. If an error occurs, the UROId is set to "".
Example:	nps upload $LISTID ATTS URID

Code	Description
0	Command successful.
2-4	Command unsuccessful. Wrong number of arguments, or incorrectly given.
17028	Command successful. Warning trying to set read-only attributes failed.
Other non-zero	Command unsuccessful. Any other error.

Variables

This section describes the environment variables supported by the configuration object interpreter and available to a flow-through application. Note that there are other environment variables which are used internally by the configuration object interpreter, therefore do not create any variables with names that start with "NPS" other than the ones described below.

.

NPSLISTREADAHEAD
Description:	Contains the number of rows of a list which are read and cached by the configuration object interpreter. This variable can be used to improve the performance of list processing. It causes the nps readitem command to read the specified number of rows in one operation, which is more efficient than reading a row at a time when sequentially processing a list.
Values:	A number in the range 1-100.
Default:	20

NPSLOG
Description:	Contains the name of the trace lot file. Trace messages are written to the file which is named in this variable.
Values:	A valid file name.
Default:	stdout

NPSMODE
Description:	Controls tracing.
Values:	Trace--Turns on tracing. Other--Turns off tracing.
Default:	Off

NPSNETOBJID
Description:	Specifies the topmost configuration object--the topmost Network object. The value of this variable is SYNetwork:1000.

NPSSESSIONID
Description:	After calling npsinit, this variable specifies the session number currently used.

SYSESSIONID
Description:	Specifies the session for configuration object interpreter. This variable must be set before calling npsinit. All following nps commands are executed in this session.
Values:	SessOld--The interpreter connects to this session. If this valued is not a valid session object id then Cisco Provisioning Center behaves as though it were unset. Note that NPSNEWSESSION takes precedence over SYSESSIONID and therefore should not be set when using SYSESSIONID. Unset--The interpreter attempts to share the existing session that has the same DISPLAY. If there is not existing session, a new one is created.
Default:	Unset

Termination Variables

Some extra environment variables are set when an nps command terminates with a non-zero code. These variables can be read or displayed by the flow-through application

.

NPSVERB
Description:	Contains the name of the last executed verb.
Values:	A single word of text.

NPSERROR
Description:	Contains the termination code from the last executed verb.
Values:	An integer.

NPSERMSG
Description:	Contains a brief text message associated with the termination code.
Values:	A text string.

NPSFULERMSG
Description:	Contains all of the text messages associated with the termination code.
Values:	A text string.

NPSEROID
Description:	Contains the object id of the object which is in error.
Values:	An object id.

NPSERCAT
Description:	Contains the category of error.
Values:	1. Succeeded without status. 2. The command succeeded but returned a non-zero status. 3. The command failed but can be retried. 4. The command failed but can be corrected and retried. 5. The command failed and cannot be retried. 6. The command failed due to a fatal system error.

:

Log	Directory	File Name
Audit Log	$CCP_AUDIT	audit TransactionNum
Event Log	$CCP_LOG/event	event
System Administration	$CCP_LOG/systemadmin	systemadmin
Site Log	$CCP_LOG/site	site TransactionNum_SiteName
Site Error Log	$CCP_LOG/siteerror	siteerror TransactionNum_SiteName

Posted: Thu Aug 3 16:31:00 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.