Summary of Script Language Commands

These tables summarize the Script Language Commands.

Session Management Commands

Table A-1: Session Management Commands

Command Description

AVtm findCR [SessID | Display | VM]

Return the open Transaction number in the indicated session.

AVtm findVMSession [Display | VM ]

Return the session id of the interactive session.

AVtm wait

Create a new session and return its id.

Command	Description
AVtm findCR [SessID \| Display \| VM]	Return the open Transaction number in the indicated session.
AVtm findVMSession [Display \| VM ]	Return the session id of the interactive session.
AVtm wait	Create a new session and return its id.

Transaction Management Commands

Table A-2: Transaction Management Commands

Command Description

AVcr abandon TransactionNum [SessId | Display | VM]

Abandon an existing Transaction.

AVcr apply TransactionNum [SessId | Display | VM]

Apply an existing Transaction to the network.

AVcr close TransactionNum [SessId | Display | VM]

Close an existing Transaction.

AVcr create [SessionId | Display | VM] [descr=Descr] [md=MD] [vpn=VPN]

Create a new Transaction and return its number.

AVcr delete TransactionNum [SessId | Display | VM]

Delete an existing Transaction.

AVcr modify TransactionNum [SessId | Display | VM] [descr=Descr] [md=MD] [vpn=VPN]

Modify an existing Transaction.

AVcr open TransactionNum [SessId | Display | VM]

Open an existing Transaction.

AVcr schedule TransactionNum applytime=<yyy-mm-dd hh:mm>[SessId | Display | VM]

Schedule a new Transaction to be applied for the future time specified.

AVcr start [SessId | Display | VM] [descr=Descr] [md=MD] [vpn=VPN}

Create and open a new Transaction, and return its number.

Command	Description
AVcr abandon TransactionNum [SessId \| Display \| VM]	Abandon an existing Transaction.
AVcr apply TransactionNum [SessId \| Display \| VM]	Apply an existing Transaction to the network.
AVcr close TransactionNum [SessId \| Display \| VM]	Close an existing Transaction.
AVcr create [SessionId \| Display \| VM] [descr=Descr] [md=MD] [vpn=VPN]	Create a new Transaction and return its number.
AVcr delete TransactionNum [SessId \| Display \| VM]	Delete an existing Transaction.
AVcr modify TransactionNum [SessId \| Display \| VM] [descr=Descr] [md=MD] [vpn=VPN]	Modify an existing Transaction.
AVcr open TransactionNum [SessId \| Display \| VM]	Open an existing Transaction.
AVcr schedule TransactionNum applytime=<yyy-mm-dd hh:mm>[SessId \| Display \| VM]	Schedule a new Transaction to be applied for the future time specified.
AVcr start [SessId \| Display \| VM] [descr=Descr] [md=MD] [vpn=VPN}	Create and open a new Transaction, and return its number.

Service Object Commands

Table A-3: Service Object Commands

Command Description

java com.syndesis.activator.Activator SOClass create AttArray

Create a new Service object and display it.

java com.syndesis.activator.Activator SOClass createWithModes AttArray

Createa new Service object and display it with modes.

java com.syndesis.activator.Activator SOClass delete AttArray

Delete an existing Service object and display it.

java com.syndesis.activator.Activator SOClass details AttArray

List the components of an existing Service object.

java com.syndesis.activator.Activator SOClass list AttArray

List the Service objects matching the criteria.

java com.syndesis.activator.Activator SOClass listProfile AttArray

List the Service profile objects matching the criteria.

java com.syndesis.activator.Activator SOClass modify AttArray

Modify an existing Service object and display it.

java com.syndesis.activator.Activator SOClass modifyWithModes AttArray

Modify an existing Service object and display it with Modes.

java com.syndesis.activator.Activator Class Function Parameters create
ArgName=Arg Value

Create a new Service object and display it.

java com.syndesis.activator.Activator Class Function Parameters createWithModes
ArgName=Arg Value

Create a new Service object and display it with modes.

java com.syndesis.activator.Activator Class Function Parameters delete
ArgName=Arg Value

Delete an existing Service object and display it.

java com.syndesis.activator.Activator Class Function Parameters details
ArgName=Arg Value

List the components of an existing Service object.

java com.syndesis.activator.Activator Class Function Parameters list
ArgName=Arg Value

List the Service objects matching the criteria.

java com.syndesis.activator.Activator Class Function Parameters listProfile
ArgName=Arg Value

List the Service profile objects matching the criteria.

java com.syndesis.activator.Activator Class Function Parameters modify
ArgName=Arg Value

Modify an existing Service object and display it.

java com.syndesis.activator.Activator Class Function Parameters modifyWithModes
ArgName=Arg Value

Modify an existing Service object and display it with modes.

Command	Description
java com.syndesis.activator.Activator SOClass create AttArray	Create a new Service object and display it.
java com.syndesis.activator.Activator SOClass createWithModes AttArray	Createa new Service object and display it with modes.
java com.syndesis.activator.Activator SOClass delete AttArray	Delete an existing Service object and display it.
java com.syndesis.activator.Activator SOClass details AttArray	List the components of an existing Service object.
java com.syndesis.activator.Activator SOClass list AttArray	List the Service objects matching the criteria.
java com.syndesis.activator.Activator SOClass listProfile AttArray	List the Service profile objects matching the criteria.
java com.syndesis.activator.Activator SOClass modify AttArray	Modify an existing Service object and display it.
java com.syndesis.activator.Activator SOClass modifyWithModes AttArray	Modify an existing Service object and display it with Modes.
java com.syndesis.activator.Activator Class Function Parameters create ArgName=Arg Value	Create a new Service object and display it.
java com.syndesis.activator.Activator Class Function Parameters createWithModes ArgName=Arg Value	Create a new Service object and display it with modes.
java com.syndesis.activator.Activator Class Function Parameters delete ArgName=Arg Value	Delete an existing Service object and display it.
java com.syndesis.activator.Activator Class Function Parameters details ArgName=Arg Value	List the components of an existing Service object.
java com.syndesis.activator.Activator Class Function Parameters list ArgName=Arg Value	List the Service objects matching the criteria.
java com.syndesis.activator.Activator Class Function Parameters listProfile ArgName=Arg Value	List the Service profile objects matching the criteria.
java com.syndesis.activator.Activator Class Function Parameters modify ArgName=Arg Value	Modify an existing Service object and display it.
java com.syndesis.activator.Activator Class Function Parameters modifyWithModes ArgName=Arg Value	Modify an existing Service object and display it with modes.

Table A-4: ArgName=ArgValue Description

ArgName=ArgValue Description

AVcr=
(TransactionNum | atomic | auto | current | none | open)

The Transaction in which the command is to work.

AVdebug=Debug Level

The debug level used for Activator classes.

AVdescription=Descr

The description of the new Transaction created by Activator.

AVformatter=
(com.syndesis.activator.DefaultFormatter |

com.syndesis.activator.SerialFormatter |

com.syndesis.activator.SimpleFormatter |

com.syndesis.activator.TNDetailsFormatter)

The class name used to format output.

AVmd=MD

The MD of the new Transaction created by Activator.

AVparser=ParserClass

The class name used to read additional attributes.

AVsession=(SessId | VM)

The session in which the command is called.

AVvpn=VPN

The VPN of the new Transaction created by Activator.

SOFirst=FirstNum

The number of the first row in a list command.

SOMax=MaxNum

The maximum number of rows to return in a list command.

ArgName=ArgValue	Description
AVcr= (TransactionNum \| atomic \| auto \| current \| none \| open)	The Transaction in which the command is to work.
AVdebug=Debug Level	The debug level used for Activator classes.
AVdescription=Descr	The description of the new Transaction created by Activator.
AVformatter= (com.syndesis.activator.DefaultFormatter \| com.syndesis.activator.SerialFormatter \| com.syndesis.activator.SimpleFormatter \| com.syndesis.activator.TNDetailsFormatter)	The class name used to format output.
AVmd=MD	The MD of the new Transaction created by Activator.
AVparser=ParserClass	The class name used to read additional attributes.
AVsession=(SessId \| VM)	The session in which the command is called.
AVvpn=VPN	The VPN of the new Transaction created by Activator.
SOFirst=FirstNum	The number of the first row in a list command.
SOMax=MaxNum	The maximum number of rows to return in a list command.

NNI Resiliency Commands

Table A-5: NNI Resiliency Commands

Command Description

java com.syndesis.resiliency.ServiceUtility linkfail Old

Re-thread the circuits over the failed link.

java com.syndesis.resiliency.ServiceUtility linkrecover Old

Restore the recovered link.

java com.syndesis.resiliency.ServiceUtility linkbalance Old

Re-balance the load across the links in the same group.

Command	Description
java com.syndesis.resiliency.ServiceUtility linkfail Old	Re-thread the circuits over the failed link.
java com.syndesis.resiliency.ServiceUtility linkrecover Old	Restore the recovered link.
java com.syndesis.resiliency.ServiceUtility linkbalance Old	Re-balance the load across the links in the same group.

UNI Resiliency Commands

Table A-6: UNI Resiliency Commands

Command Description

java com.syndesis.resiliency.ServiceUtility uni fail FullPortName

Fails a foreground logical port and moves PVCs to a background logical port.

java com.syndesis.resiliency.ServiceUtility uni recover FullPortName

Restores PVCs to the recovered foreground logical port.

Command	Description
java com.syndesis.resiliency.ServiceUtility uni fail FullPortName	Fails a foreground logical port and moves PVCs to a background logical port.
java com.syndesis.resiliency.ServiceUtility uni recover FullPortName	Restores PVCs to the recovered foreground logical port.

Configuration Object Commands

In this section, an argument that is passed by name is defined with the notation N after the argument.

Table A-7: Configuration Object Commands

Command Description

. npsinit

Initialize the configuration object interpreter.

nps create Class AttArray NOld N

Create a new object.

nps delete Old

Delete the object.

nps error

Check for errors.

nps getlabels Old AttLabelArrayN

Return the attribute labels for the object.

nps gettitle Old ClassNClasstitleN

Return the class and title of the object.

nps insert AttArrayNAttName AttValue

Insert the attribute value assertion into the AttArray.

nps list Class Criteria

Display the GUI list viewer.

nps modify Old AttArrayN

Modify the object with the values in the AttArray.

nps modifymodes Old AttModeArrayN

Modify the profile with the modes in the AttMode Array.

nps read Old AttArrayN

Read the object's attributes into the AttArray.

nps readitem ListId ItemNum OldN AttArrayN

Read an item from the list.

nps readmodes Old AttModeArray

Read the object's attribute modes into the AttModeArray.

nps reslectmany ListId NumItems Criteria

Regenerate the list.

nps retrieve AttArrayN AttName AttValueN

Retrieve the named attribute from the AttArray.

nps selectallversions Old ListId N NumItemsN

Create a list of all versions of the object.

nps selectmany Class Criteria ListId N NumItemsN

Create a list of objects matching the criteria.

nps selectone Class Criteria OldN

Return the Old of the object matching the criteria.

nps split "AttValueAssertion" AttNameN AttValueN

Split the AttValueAssertion into its constituent parts.

nps stop

Stop the configuration object interpreter.

nps trace Text

Write the text to the trace file.

nps view Old

Display a GUI object viewer.

nps upload Old AttArrayN UROld N

Upload the object with upload details in AttArray.

nps upload ListId AttArrayN UROld N

Upload the list of objects with upload details in AttArray.

Command	Description
. npsinit	Initialize the configuration object interpreter.
nps create Class AttArray NOld N	Create a new object.
nps delete Old	Delete the object.
nps error	Check for errors.
nps getlabels Old AttLabelArrayN	Return the attribute labels for the object.
nps gettitle Old ClassNClasstitleN	Return the class and title of the object.
nps insert AttArrayNAttName AttValue	Insert the attribute value assertion into the AttArray.
nps list Class Criteria	Display the GUI list viewer.
nps modify Old AttArrayN	Modify the object with the values in the AttArray.
nps modifymodes Old AttModeArrayN	Modify the profile with the modes in the AttMode Array.
nps read Old AttArrayN	Read the object's attributes into the AttArray.
nps readitem ListId ItemNum OldN AttArrayN	Read an item from the list.
nps readmodes Old AttModeArray	Read the object's attribute modes into the AttModeArray.
nps reslectmany ListId NumItems Criteria	Regenerate the list.
nps retrieve AttArrayN AttName AttValueN	Retrieve the named attribute from the AttArray.
nps selectallversions Old ListId N NumItemsN	Create a list of all versions of the object.
nps selectmany Class Criteria ListId N NumItemsN	Create a list of objects matching the criteria.
nps selectone Class Criteria OldN	Return the Old of the object matching the criteria.
nps split "AttValueAssertion" AttNameN AttValueN	Split the AttValueAssertion into its constituent parts.
nps stop	Stop the configuration object interpreter.
nps trace Text	Write the text to the trace file.
nps view Old	Display a GUI object viewer.
nps upload Old AttArrayN UROld N	Upload the object with upload details in AttArray.
nps upload ListId AttArrayN UROld N	Upload the list of objects with upload details in AttArray.

Table of Contents