Corba Language Reference (IDL Files)

Service objects management--allows you to create, modify, delete and retrieve information about Service objects
NNI resiliency management--allows you to fail, recover, and rebalance links in the network
UNI resiliency management--allows you to fail and recover primary logical ports in the network
Transaction management--allows you to open, close, schedule, apply, abandon, and delete Transactions
Session management--allows you to create and manage sessions

The SYcrbAV module consists of the following interfaces:

Service object manager
NNI resiliency manager
UNI resiliency manager
Transaction manager
Session
Session Factory

CORBA NPT Module

The CORBA NPT (SYcrbNPT) module provides access to the management functions of Cisco Provisioning Center. This includes the following areas:

Session management--allows you to create and manage sessions
Lister interface--allows you to list configuration objects
Network Element interface--provides access to configuration objects

The SYcrbNPT module consists of the following interfaces:

Session, Session Factory
Lister
Site Item Lister
Event Source, Event Source Factory
MetaData Server
Upload Request, Upload Request Factory
Network Element, Network Element Factory
Persistent, Managed

Note Client application developers should use the SYcrbAV session management interfaces, not the SYcrbNPT session management interfaces.

The IDL file mentioned above makes use of the Naming Service IDL, the Event Service IDL, and the CORBA Life Cycle Service IDL. The event.idl and lifecyclesservices.idl files are shipped to be used for the development of clients of the Cisco Provisioning Center interface. The Life Cycle Service IDL, is included in the $CCP_REL/sys/idl directory. The Event Service IDL file is located in the $CCP_REL/sys/corba/OrbixEvents.1.0/Untyped1.0c/idl/directory. The Naming Service IDL file is located in the $CCP_REL/sys/corba/OrbixNames_1.1/idl/directory. They are not defined in this chapter.

Cisco Provisioning Center Enums

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

SYcrbAV::TransactionMode--This is used to select the Transaction mode. It can be one of the following:

Atomic--Cisco Provisioning Center 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--Cisco Provisioning Center uses the Transaction that is open in the current session if there is one, and automatically creates and opens one if not.

Current--Cisco Provisioning Center uses the Transaction that is open in the current session if there is one, or none at all. If the CORBA command requires an open Transaction then not having one causes an error.

Open--Cisco Provisioning Center 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.

Specified--Cisco Provisioning Center works within the Transaction specified by the given CRID. If that Transaction is already open in the session then Cisco Provisioning Center uses it. If that Transaction is open in another session or another Transaction is open in the current session then Cisco Provisioning Center throws an error. If no Transaction is open, then Cisco Provisioning Center opens the specified Transaction for the session.

None--Cisco Provisioning Center check that there is no Transaction open in the current session, and throws and error otherwise. If the CORBA command requires an open Transaction then not having one also causes an error.

SYcrbAV::CRID--This is used to specify the object ID of the Transaction. For example, "SYcadChangeOrder:1001"

SYcrbAV::LINKID--This is used to specify the link object ID.

SYcrbNPT::Operation--This specifies the comparison operation is the SYcrbNPT::Lister search criteria. It can be one of the following:

EqualTo
Like
CaseLike
NotEqualTo
NotLike
CaseNotLike
GreaterThan
GreaterThanOrEqualTo
LessThan
LessThanOrEqualTo

SYcrbNPT::order--This specifies the order in which SYcrbNPT::Lister results can be stored. It can be one of the following:

AscendingOrder
DescendingOrder

SYcrbNPT::Mode --This specifies the mode of an object attribute. It can be one of the following:

UnknownMode
ReadOnlyMode
ReadWriteMode
ProfileReadOnlyMode
ProfileReadWriteMode
GuiMode

SYcrbNPT::PendingOperation --This specifies the pending operation returned from the SYcrbNPT::Managed::getPendingOperation method. It can be one of the following:

UnknownPending
NoPending
NewPending
Add Pending
ModifyPending
DeletePending
ReloadPending

SYcrbNPT::Permission --This specifies the permission associated with an action as returned by SYcrbNPT::Persistent::getPermittedActions and SYcrbNPT::Lister::getPermittedActions. It can be one of the following:

YesPermission
NoPermission
NeverPermission
UnknownPermission

SYcrbNPT::Category --This specifies the category associated with a Cisco Provisioning Center or CPC exception. Normally, exceptions are only thrown with one of the failed categories. It can be one of the following:

succeeded
suceededWithStatus
failedWaitAndRetry
failedCorrectAndRetry
failedNoRetry
fatalFailure

SYcrbNPT::Severity --This specifies the category associated with a given error message in a stack of error messages in a Cisco Provisioning Center of CPC exception. It can be one of the following:

information
warning
problem
error
fatal

SYcrbNPT::Verbosity --This specifies the verbosity associated with a given error message in a stack of error messages in a Cisco Provisioning Center of CPC exception. It can be one of the following:

user
normal
enhanced
detailed

SYcrbNPT::EventSource::FilterMode --This specifies the filter mode used when enabling and disabling events. It can be one of the following:

intraSession--Events generated inside the same session you are running
interSession--Events generated in other sessions
allSession--Events generated in all sessions

General Constants

Transaction States

The following constants define the names for the transaction states for the TransactionManager Interface.

Ready State
"Ready"

Current State
"Current"

Busy State
"Busy"

Scheduled State
"Scheduled"

Applied State
"Applied"

Alert State
"Alert"

Abandoned State
"Abandoned"

Action Names

The following constants define the names for the actions for the getPermittedActions and getReasonNotPermitted operations in the Persistent Interface and/or Lister interface for persistent objects.

CHOOSE_ACTION
"CHOOSE"

DISPLAY_ACTION
"DISPLAY"

GETLIST_ACTION
"GETLIST"

NEW_ACTION
"NEW"

REMOVE_ACTION
"REMOVE"

SAVE_ACTION
"SAVE"

UNDO_ACTION
"UNDO"

UPLOAD_ACTION
"UPLOAD"

VIEW_ACTION
"VIEW"

ZOOM_ACTION
"ZOOM"

Attribute Names

The following constants define the attribute names for the internal and system attributes for the getValue and getAttributes operations in the Persistent Interface.

SY_OBJECTID_COLUMN
"sy_objectid"

SY_RETURNOID_COLUMN
"sy_returnid"

SY_CREATEDATE_COLUMN
"sy_createdate"

SY_MODIFIEDDATE_COLUMN
"sy_modifieddate"

SY_SEQUENCENUMBER_COLUMN
"sy_sequencenumber"

Computed Attribute Names

The following constants define the attribute names for the computed internal and system attributes for the getValue and getAttributes operations in the Persistent Interface.

CURRENT_COID_ATTRIBUTE
"current_coid"

CURRENT_CRNUMBER_ATTRIBUTE
"current_crnumber"

PENDING_OPERATION_ATTRIBUTE
"pending_operation"

PENDING_STATUS_ATTRIBUTE
"pending_status"

Computed Attribute Values

The following constants define the values for the pending_status attribute for the getValue and getAttributes operations in the Persistent Interface.

CURRENT_NO_PENDING_STATUS
"CURRENTNOPENDING"

CURRENT_WITH_PENDING_STATUS
"CURRENTWITHPENDING"

CURRENT_WITH_INVALID_PENDING_STATUS
"PENDING"

INVALID_PENDING_STATUS
"INVALID"

Version Values

The following constants define the values for the sy_version attribute for the getValue and getAttributes operations in the Persistent Interface.

CURRENT_VERSION
"0"

CURRENT_VERSION_NUM
0

PENDING_VERSION
"1"

PENDING_VERSION_NUM
1

Pending Operation Values

The following constants define the values for the sy_pendoperation attribute for the getValue and getAttributes operations in the Persistent Interface.

ADD_PENDING_OPERATION
"0"

ADD_PENDING_OPERATION_NUM
0

MODIFY_PENDING_OPERATION
"1"

MODIFY_PENDING_OPERATION_NUM
1

DELETE_PENDING_OPERATION
"2"

DELETE_PENDING_OPERATION_NUM
2

RELOAD_PENDING_OPERATION
"3"

RELOAD_PENDING_OPERATION_NUM
3

NO_PENDING_OPERATION
"4"

NO_PENDING_OPERATION_NUM
4

NEW_PENDING_OPERATION
"5"

NEW_PENDING_OPERATION_NUMB
5

Cisco Provisioning Center Typedefs and Structs

typedefs

typedef
string
ObjectId

typedef
string
ClassId

typedef
long
DbId

typedef
string
AttributeName

typedef
string
AttributeValue

typedef
long
ErrorNumber

typedef
string
ErrorText

typedef
ObjectId
PersistentId

typedef
string
AttributeItem

typedef
string
AttributeResultItem

typedef
string
UniqueByItem

typedef
sequence<char>
charSeq;

typedef
sequence<string>
stringSeq;

typedef
sequence<ObjectId>
ObjectIdSeq;

typedef
sequence<AttributeValueItem>
AttributeValueItemSeq;

typedef
sequence<AttributeValueAndModeItem>
AttributeValueAndModeItemSeq

typedef
sequence<AttributeValueAndGuiModeItem>
AttributeValueAndGuiModeItemSeq;

typedef
sequence<ActionItem>
ActionItemSeq;

typedef
sequence<PermissionItem>
PermissionItemSeq;

typedef
sequence<UpLoadItem>
UpLoadItemSeq;

typedef
sequence<SubtypeItem>
SubtypeItemSeq;

typedef
sequence<AttributeError>
AttributeErrorItemSeq;

typedef
sequence<SearchItem>
SearchItemSeq;

typedef
sequence<AttributeItem>
AttributeItemSeq;

typedef
sequence<AttributeResultItem>
AttributeResultItemSeq;

typedef
sequence<AttributeResultItemSeq>
AttributeResultItemSeqSeq;

typedef
sequence<OrderByItem>
OrderByItemSeq;

typedef
sequence<UniqueByItem>
UniqueByItemSeq;

typedef
sequence<ErrorMessage>
ErrorMessageSeq;

typedef
sequence<MVCEvent>
MVCEventSeq;

typedef
long
EventSourceId;

typedef
sequence<EventSourceId>
EventSourceIdSeq;

structs

struct Attribute ValueItem

AttributeName
name

AttributeValue
value

struct AttributeValueAndModelItem

AttributeName
name

AttributeValue
value

Mode
mode

struct AttributeValueAndGuiModelItem

AttributeName
name

AttributeValue
value

Mode
mode

string
guiMode

struct ActionItem

string
name

string
parm1

string
parm2

struct PermissionItem

string
name

Permission
permission

string
reason

struct UpLoadItem

string
key

string
value1

string
value2

struct SubtypeItem

classId
className

string
description

struct SearchItem

attributeName
name

Operation
operation

AttributeValue
value

struct OrderByteItem

 

AttributeName
name

Order
order

struct MVCEvent

string
evenClass
"CMS" for fabric and service element object,"CCS" for transaction and upload request objects

string
eventType
one of the "new", "modify", "delete", "revert", "commit", "reject"

ObjectIdSeq
modeIds
ObjectIdSeqmodelIds - a sequence of objects ids of the object changed

string
parameters
string parameters contain the number of the foreground or background session where the change originated; when intraSession events are enabled significant events in other sessions will be delivered with a parameter of "0"

Cisco Provisioning Center Exceptions

Structs

struct AttributeErrorItem

AttributeName
name
name of the errored attribute

ErrorNumber
number
error number

ErrorText
text
message describing why the value of this attribute is in error

struct ErrorMessage

string
vendor
the vendor of the software that generated the error (SY for Syndesis)

string
application
the name of a software application process

string
pid
the UNIX process where the error was generated

string
subsystem
the name of a software subsystem

Severity
severity

verbosity
verbosity

objectId
objectId
the object id of the object being processed when the error occurred

ErrorNumber
ident
an error number

ErrorText
message
a printable error message

struct ErrorStack

ErrorNumber
status
an error number

Category
category
an error category

ErrorMessageSeq
errors
a sequence of error messages

struct AVStackExceptionDetails

Cisco Provisioning Center equivalent to NptException.

SycrbNPT::ErrorNumber
status

SYcrbNPT::ErrorMessageSeq
errors

struct AVSaveExceptionDetails

Cisco Provisioning Center equivalent to NptSaveException.

SYcrbNPT::ErrorNumber
status

SYcrbNPT::ErrorMessageSeq
errors

SYcrbNPT::AttributeErrorItemSeq
failedAttributes-describes the attributes that prevented the object from being saved

struct AVNumberedExceptionDetail

It corresponds to a numbered Cisco Provisioning Center exception of the following classes (class name stored in exception class). It is one of:

com.syndesis.activator.ActivatorException
com.syndesis.activator.AttributeNotFoundException
com.syndesis.activator.BRMFailedException
com.syndesis.activator.GRMFailedException
com.syndesis.activator.ServiceFailedException

struct AVUnNumberedExceptionDetails

It corresponds to a standard Java exception (class name stored in exception class). For example, java.lang.IOException.

String
exceptionClass

union AVExceptionDetails

It uses AVExceptionDetailTypes as a discriminator to select between one of AVStackExceptionDetails, AVSaveExceptionDetails, AVNumberExceptionDetails, or AVUnNumberedExceptionDetails.

Exceptions

exception NptException

ErrorStack
errorStack

exception NptGetValueException

ErrorStack
errorStack

AttributeValue
returnedValue

exception NptSaveException

ErrorStack
errorStack

AttributeErrorItemSeq
failedAttributes

exception AVException

This is a basic Activator exception.

SYcrbNPT::Category
category

SYcrbNPT::ErrorText
message

AVExceptionDetails
details

CRID
abandonedTransactionId

exception NoSuchEventSource

An exception that is thrown when a invalid EventSourceId is passed as a parameter to an EventSourceFactory method.

exception noSuchEvent

An exception is thrown when a type of event is disabled that was not previously enabled.

exception AVAutoTransactionException

SYcrbNPT::Category
category

SYcrbNPT::ErrorText
message

AVExceptionDetails
details

CRID
abandonedTransactionId

enum AVExceptionDetails types

StackDetails
SaveDetails
NumberDetails
UnNumber Details

SYcrbAV Module

Service Object Manager Interface

The CORBA interface provides access to Service objects. The Service Object Manager Interface is implemented through the following operations (also called methods).

Note When the transactionMode= =Specified, the transactionId must contain the object id of the required transaction, otherwise it should be initialized to "".

create

Usage:

SOID create (in TransactionMode transactionMode, inout CRID transactionId, in SycrbNPT::AttributeValueItemSeq transactionAttributes, inout ReadSycrbNPT::AttributeValueItemSeq soAttributes) raises AVAutoTransactionException)

Description:

Creates a new Service object with the given attributes. If soAttributes specifies a Service object profile (with attribute srprofile or srprofile.sy_profname (or its supported alias profilename)), 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). Note that attribute modes are NOT enforced by this command and read-only attributes can be modified if so desired.

Parameters:

transactionAttributes--This is used to select the transaction attributes. It can be one or more of the following: briefdescription, domain, vpn.

soAttributes--This is used to specify the attributes of the Service object and return the values of all service object attributes.

modify

Usage:

void modify (in SOID id, in TransactionMode transactionMode, inout CRID transactionId, in SYcrbNPT::AttributeValueItemSeq transactionAttributes, inout SYcrbNPT::AttributeValueItemSeq soAttributes) raises

(AVAutoTransactionException)

Description:

Modifies the given Service Object with the given attributes. The Service object must be specified using the object id in the SOID is input parameter. If soAttributes specifies a Service object profile (with attribute srprofile or srprofile.sy_profname (or its supported alias profilename)), 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). Note that attribute modes are not enforced by this command and read-only attributes can be modified if so desired.

Parameters:

transactionAttributes--This is used to select the transaction attributes. It can be one or more of the following: briefdescription, domain, vpn.

soAttributes--This is used to specify the attributes of the Service object and return the values of all service object attributes.

delete

Usage:

void del (in SOID id, in TransactionMode transactionMode, inout CRID transactionId, in SYcrbNPT::AttributeValueItemSeq transactionAttributes, inout SYcrbNPT::AttributeValueItemSeq soAttributes)

Description:

Deletes the given Service object. The Service object must be specified using the object id in the SOID id input parameter.

Parameters:

transactionAttributes--This is used to select the transaction attributes. It can be one or more of the following: briefdescription, domain, vpn.

soAttributes--This is used to specify the attributes of the Service object and return the values of all service object attributes.

get all attributes

Usage:

void getAllAttributes (in SOID id, in TransactionMode transactionMode, inout CRID transactionId, out SYcrbNPT::AttributeValueItemSeq soAttributes) raises (AVAutoTransactionException)

Description:

Returns the attributes of the given Service object.

Parameters:

soAttributes--This is used to specify the attributes of the Service object and return the values of all service object attributes.

get all attributesWithModes

Usage:

void getAllAttributesWithModes (in SOID id, in TransactionMode transactionMode, inout CRID transactionId, out SYcrbNPT::AttributeValueAndItemSeq soAttributesAndModes, raises (AVAutoTransactionException)

Description:

Same as the get AllAttributes command, except this command also returns the attribute modes of the given Service object. The Service object must be specified using the object id in the SOID id input parameter.

get details

Usage:

void getDetails (in SOID id) in TransactionMode transactionMode, inout CRID transactionId, out Attribute

ValueItemSeqSeq detailsAttributes) raises (AVAutoTransactionException)

Description:

Same as the getAllAttributes command, except this command also returns the attributes modes of the given Service object. The Service object must be specified using the object id in the SOID id input parameter.

list all attributes

Usage:

void listAllAttributes (in TransactionMode transactionMode, inout CRID transactionId, in SYcrbNPT::AttributeValueItemSeq criteria, out AttributeValueItemSeqSeq results) raises (AVAutoTransactionException)

Description:

Returns the zero or more Service objects which match the given search criteria. Any attributes of the Service object can used as criteria, not just the selector attributes identified in its OAF.

Parameters:

criteria--the search criteria, including:

SOFirst=FirstNum--The number of the first object to be returned by the listAllAttributes command. The first object is numbered 1, the second is numbered 2, and so on. The default is 1.

SOMax=MaxNum--The maximum number of objects to be returned by the listAllAttributes command, starting at the SOFirst object to the SOFirst + SOMax - 1) object.

get all profile attributes

Usage

void getAllProfileAttributes (in SOID id, in TransactionMode transactionMode, inout CRID transactionId, out SYcrbNPT::AttributeValueAndModeItemSeq profileAttributes) raises AVAutoTransactionException)

Description:

Returns the attribute values and modes of the given Service profile. The Service profile must be specified using the object id in the SOID id input parameter.

list all profile attributes

Usage:

void listAllProfileAttributes (in SOID id, in TransactionMode transactionMode, inout CRID transactionId, in SYcrbNPT::AttributeValueItemSeq criteria, out AttributeValueItenSeqSeq results) raises (AVAutoTransactionException)

Description:

Returns all attributes of zero or more Service profiles which match the given search criteria. Any attributes of the Service profile can be used as criteria, not just the selector attributes identified in its OAF.

Parameters:

criteria--the search criteria, including:

SOFirst=FirstNum--The number of the first object to be returned by the listAllAttributes command. The first object is numbered 1, the second is numbered 2, and so on. The default is 1.

SOMax=MaxNum--The maximum number of objects to be returned by the thelistAllAttributes command, starting at the SOFirst object to the (SOFirst + SOMax -1) object.

generic requestion

Usage:

void genericrequest (in TransactionMode transactionMode, inout CRID transactionId, in SYcrbNPT::AttributeValueItemSeq transactionAttributes, in string, methodName, inout string methodParameters) raises (AvAutoTransactionException)

Description:

This is a generic method interface, behavior is instance specific.

Parameters:

methodName--name of the method

methodParameters--the method parameters

transactionAttributes--This is used to select the transaction attributes. It can be one or more of the following:briefdescription, domain, vpn.

NNI Resiliency Manager Interface

The NNI Resiliency Manager Interface is implemented through the following operations (also called methods):

linkFail

Usage:

void linkFail (in LINKID link) raises (AVException)

Description:

Re-threads the circuits running over the specified failed link. This command returns when it either succeeds or fails.

Parameters:

link--ID of the link

linkRecover

Usage:

void linkRecover (in LINKID link) raises (AVException)

Description:

Restores the specified recovered link. This command returns when it either suceeds or fails.

Parameters:

link--ID of the link

linkRebalance

Usage:

void linkRebalance (in LINKID link) raises (AVException)

Description:

Re-balances the load across links in the same group as the indicated link. This command returns when it either suceeds or fails.

Parameters

link--ID of the link

UNI Resiliency Manager Interface

The UNI Resiliency Manager Interface is implemented through the following operations (also called methods):

unifail

Usage:

void unifail (in LPNAME logical port name) raises (AVException)

Description:

Fails a foreground logical port. This command returns when it either suceeds or fails.

Parameters:

logical port name--name of the Logical Port name

unirecover

Usage:

void unirecover (in LPNAME logical port name) raises (AVException)

Description:

Restores the foreground logical port. This command returns when it either succeeds or fails.

Parameters:

logical port name--name of the Logical Port name

Transaction Manager Interface

The Transaction Manager Interface is implemented through t he following operations (also called methods). The states that a transaction goes through during processing are outlined, in order, in the list below:

Ready
Current
Scheduled
Busy
Applied
Alert
Abandoned

CRID create

Usage:

CRID create (in SYcrbNPT::AttributeValueItenSeq attributes) raises (AVException)

Description:

Creates a new Transaction but does not open it. This command returns the object id of the Transaction.

Parameters:

attributes--This is used to select the transaction attributes. It can be one of the following: briefdescription, domain, vpn.

Crid start

Usage:

CRID start (SycrbNPT::AttributeValueItemSeq attributes)

Description:

Starts a new Transaction with the given BriefDescription, MD, and VPN. This command creates a new Transaction, opens it and then returns the object id of the Transaction.

Parameters:

attributes--This is used to select the transaction attributes. It can be one of the following: briefdescription, doman, vpn.

Open

Usage:

void open (in CRID id) raises (AVException)

Description:

Opens a transaction.

Parameters:

id--specifies the Transaction ID

close

Usage:

void close (in CRID id) raises (AVException)

Description:

Closes a previously opened Transaction.

Parameters:

id--specifies the transaction ID

schedule

Usage:

void schedule (in CRID id) raises (AVException)

Description:

Schedules the Transaction to be applied to the network at the specified future date. This command waits until the Transaction either succeeds to the Applied state or fails to the Abandoned state.

Parameters:

id--specifies the transaction ID

apply

Usage:

void apply (in CRID id) raises (AVException)

Description:

Applies the transaction to the network. This command waits until the Transaction either succeeds to the Applied state or fails to the abandoned state.

Parameters:

id--specifies the transaction ID

abandon

Usage:

void abandon (in CRID id) raises (AVException)

Description:

Abandons the Transaction. This command waits until the Transaction is abandoned.

Parameters:

id--specifies the transaction ID

abort

Usage:

void abort (in CRID id) raises (AVException)

Description:

Aborts the Transaction in the Scheduled state and returns it to the Ready state. This command waits until the Transaction is abandoned.

Parameters:

id--specifies the transaction ID

del

Usage:

void del (in CRID id) raises (AVException)

Description:

Deletes the Transaction and all associated files. It deletes the Transaction by closing it if it is open or abandoning it if it is in the R eady st ate. Delete is possible from th Ready and Current states.

Parameters:

id--specifies the transaction ID

setAttributes

Usage:

void setAttributes (in CRID id, in SYcrbNPT::AttributeValueItemSeq attributeNames, out SYcrbNPT::AttributeValueItemSeq attributes) raises (AVException)

Description:

Provides the user with a mechanism for modifying the value of briefdescription, domain, and vpn.

Parameters:

id--specifies the transaction ID

attributeNames--attribute names

attributes--This is used to select the transaction attributes. It can be one of the following: briefdescription, domain, vpn.

getAttributes

Usage:

void getAttributes (in CRID id) in SYcrbNPT::AttributeValueItemSeq attributes) raises (AVException)

Description:

Provides the user with a mechanism for getting the values for a specified set of object attributes and their associated modes.

Parameters:

id--specifies the transaction ID

attributesNames--attribute names

attributes--returned attribute name and values

getAllAttributes

Usage:

void getAllAttributes (in CRID id) in SYcrbNPT::AttributeValueItemSeq attributes) raises (AVException)

Description:

Provides the user with a mechanism for getting all values.

Parameters:

id--specifies the Transaction ID

attributes--returned attribute name and values

listAllAttributes

Usage:

void listAllAttributes (in CRID id) in SYcrbNPT::AttributeValueItemSeq criteria) raises (AVException)

Description:

Lists Transactions and returns all of the attributes of matching objects

Parameters:

criteria--search criteria, including:

SOFirst=FirstNum--The number of the first object to be returned by the listAllAttribute command. The first object is numbered 1, the second 2, and so on. The default is 1.

SOMax=MaxNum--The maximum number of objects to be returned by the listAllAttributes command, starting at the SOFirst object to the (SOFirst + SOMax -1) object.

Session Factory Interface

The SYcrbAV Session Factory interface is derived from the SYcrbNPT interfaces. It is implemented through the following operations (also called methods):

create master

Usage:

Session createMaster (in string userName, in string sessionType) raises (NptException)

Description:

Creates a session. The user name determines access privileges.

attach master

Usage:

Session attachMaster (in ObjectId sessioniId) raises (NptException)

Description:

Attaches to an existing session specifiying the session object id.

attach master long

Usage:

Session attachMasterL (in long sessionid) raises (NptException)

Description:

Attaches to an existing session specifying the session id as an integer.

Session Interface

The SYcrbAV Session interface is derived from the SYcrbNPT interfaces. It is implemented thought the following operations (also called methods):

get services

Usage:

CosNaming::Naming Context getServices ()

Description:

Get the list of services.

get session id

Usage:

DbId getSessionId ()

Description:

Returns the session id as an integer.

get open CR

Usage:

PersistentId getOpenCR () raises (NptException)

Description:

Returns to the current Transaction object id.

remove

Usage:

void remove ()

Description:

This operation ends the session.

SycrbNPT Module

Lister Interface

The lister interface is implemented through the following operations (also called methods):

get object ID

Usage:

ObjectId get ObjectId () raises (NptException)

Description:

Gets the object ID of the Lister. Note that Lister objects are not persistent. Use of this method should not be required in most situations.

get criteria

Usage:

void GetCriteria (outSearchItemSeq searchList), out AttributeItemSeq columnList, out OrderByItemSeq orderByList, out UniqueByItemSeq uniqueByList, out boolean noDeletePending) raises (NptException)

Description:

Gets the criteria set in a previous getList.

Parameters:

searchList--the search criteria

columnList--the object attributes to be returned

orderByList--specifies which column(s) the results should be sorted by, and whether ascending or descending order is required

uniqueByList--specifies the column(s) used to identify and remove duplicate rows in the results

get list

Usage:

void getList (outSearchItemSeq searchList), out AttributeItemSeq columnList, out OrderByItemSeq orderByList, in UniqueByItemSeq uniqueByList) raises (NptException)

Description:

Provides the user with a mechanism for setting the search criteria and performing the database query for records which match the search criteria. Any criteria can be used for the getList operation with the exception of computed attributes and computed relationships. The database is queried and the results are stored in memory in the Cisco Provisioning Center Server. Results are subsequently obtained by the Client by calling getItems.

Paramters:

searchList--the search criteria

columnList--the object attributes to be returned

orderByList--specifies which column(s) the results should be sorted by, and whether ascending or descending order is required

uniqueByList--specifies the column(s) used to identify and remove duplicate rows in the results

get full list

Usage:

void getFullList (outSearchItemSeq searchList), out AttributeItemSeq columnList, out OrderByItemSeq orderByList, out UniqueByItemSeq uniqueByList) raises (NptException)

Description:

Provides the user with a mechanism for setting the search criteria and performing the database query for records which match the search criteria. Any criteria can be used for the getList operation with the exception of computed attributes and computed relationships. All rows are returned, current and pending even if for another Transaction.

Parameters:

searchList--the search criteria

columnList--the object attributes to be returned

orderByList--specifies which column(s) the results should be sorted by, and whether ascending or descending order is required

uniqueByList--specifies the column(s) used to identify and remove duplicate rows in the results

get count

Usage:

long getCount () raises (NptException)

Description:

Provides the user with a mechanism for getting the count of records which match the search criteria. Note that this can be called only after calling getList or getFullList

get items

Usage:

void getItems (in long fromItem, in long toItem, out AttributeItemSeq names, out AttributeResultItemsSeqSeq results) raises (NptException)

Description:

Provides the user with a mechanism for getting the object which matched the search criteria. The following data is returned for each object which matched the search critieria: result columns specified by setCriteria, object,id, pending operation: none, add, modify, delete, reload. Note that this can be called only after calling getList or getFullList.

Parameters:

fromItem--the index of the first results row to be returned (numbered for 1, not 0)

toItem--the index of the last results row to be returned

names--attribute column names for returned results

results--attribute values (first dimension select the row, second dimension selects the column)

clear list

Usage:

void clearList () raises (NptException)

Description:

Clears the result list of the last getList or getObject. This frees up memory resources on the Cisco Provisioning Center Server but does not remove the CORBA Lister object. The perferred approach is to use the remove operation that removes the CORBA Lister object as well as freeing up the memory associated with the query results.

get permited actions

Usage:

void getPermittedActions (in ActionItemSeq actions, out PermissionItemSeq permission) raises (NptException)

Description:

Provides the user with a mechanism for determining whether or not a set of actions is permitted.

get reason not permitted

Usage:

string getReasonNotPermitted (in string actionName, out ErrorName number) raises (NptException)

Description:

This operation returns the reason why the action is not permitted.

Parameters:

number--returns an error number

generic request

Usage:

void genericRequest (in string command, inout string parameters) raises (NptException)

Description:

This is a generic method interface, behavior is instance specific.

Parameters:

command--the command name

parameters--the string parameter

integrated request

Usage:

void intergratedRequest (in string command, inout string parameters) raises (NptException)

Description:

The is a generic method interface, behavior is instance specific.

Parameters:

command--the command name

inputParameter--one input string parameter for the command

outputParameter--one output string parameter for the command

get sub types

Usage:

void getSubtypes (out SubtypeItemSeq subtypeList) raises (NptException)

Description

Provides the user with a mechanism for getting the subtypes associated with this object class. This method returns the list of subtypes and the object id for a new object of each subtype.

remove (from CosLifeCycle::LifeCycleObject)

Usage:

void remove ()

Description:

Deletes the Lister object from the Cisco Provisioning Center Server.

Site Item Lister Interface

Site Item Lister is derived from Lister. It supports all of the methods defined for Lister, plus the following. Site Item Lister is used to list the attributes of sites associated with a specific Transaction.

set CR

Usage:

void setCR (in PersistentId changeOrderId) raises (NptException)

Description:

Associate the site item lister with the specified Transaction

Parameters:

changeOrderId--ID of the Change Request

Event Source Interface

The event source interface is implemented through the following operations (also called methods):

enable event

Usage:

void enableEvent (in string eventClass, in string eventType, in ObjectIdSeq modelIds, in FilterMode filter) raises (NptException)

Description:

Selects the types of events forwarded to the event channel. By default, no events are forwarded. This method can be called more than once and the results are cumulative.

Parameters:

eventClass--the class of the event

eventType--the type of the event

modellds--a list of the model for which the event was generated

disable event

Usage:

void disableEvent (in string eventClass, in string eventType, in ObjectIdSeq modelIds, in FilterMode filters) raises (noSuchEvent, NptException)

Description:

Disables a type of events that was previously enabled.

Parameters:

eventClass--the class of the event

eventType--the type of the event

modelIds--a list of the model for which the event was generated

get event channel

Usage:

CosEventChannelAdmin::EventChannel getEventChannel ()

Description:

Get the CORBA event channel associated with this EventSource.

get event source ID

Usage:

EventSourceId get EventSourceId ()

Description:

Get the EventSourceId of this EventSource.

Event Source Factory Interface

create event source

Usage:

EventSource createEventSource (in CosEventChannelAdmin::EventChannel channel, out EventSourceId id) raises (NptException)

Description

Forwards internal Cisco Provisioning Center database change events onto a CORBA Event Service channel. The client application is responsible for creating (and deleting) the event channel. The event channel is passed as an input parameter tot his method. A reference to the EventSource object created is returned as well as the assigned EventSource Id.

Creates a new EventSource object. An EvenSource object is an object within the Cisco Provisioning Center Server.

Parameters:

channel--the event channel

id--ID of the event source

destroy event source

Usage:

void destroyEventSource (in EventSourceId id) raises (noSuchEventSource)

Description:

Deletes an EventSource object. The ojbect to be deleted is identified by its EventSource.

Parameters:

id--ID of the event source

get event source

Usage:

EventSource getEventSource (in EventSourceId) raises (noSuchEventSource)

Description:

Returns a r eference to the EventSource object given its EventSourceId.

Parameters:

id--Id of the event source

get all event sources

Usage:

EventSourceIdSeq getAllEventSources ()

Description:

Returns the EventSourceIds of all of the EventSources in this session.

Metadata Server Interface

The metadata Server interface is implemented through the following operations (also called methods):

get all attribute names

Usage:

void getAllAttributeNames (in Classid className,out AttributeItemSeq names) raises (Npt Exception)

Description:

Returns all attribute names for the specified class.

Parameters:

className--the classname, defined in the OAF

names--the list of attribute names

Upload Request Interface

Upload Request in derived from Persistent. It supports the methods defined for Persistent plus the following:

abort upload request

Usage:

perationaborts an upvoid abort () raises (NptException)

Description:

This operation aborts an upload request that is running.

Upload Request Factory Interface

Upload Request Factory is derived from Persistent Factory. The upload request factory interface is implemented through the following operations (also called methods):

bind upload request

Usage:

UploadRequest bindUploadRequest (in PersistentId id) raises (NptException)

Description:

This operation passes an object id for the upload request into the bind and it will give you a CORBA object reference to the upload request.

Parameters:

id--specifies the persistent object ID.

Network Element Interface

Network Element is derived from Managed, which is derived from Persistent. The network element interface is implemented through the following operations (also called methods):

upLoad

Usage:

PersistentId upLoad (in UpLoadItemSeq parameters) raises (NptException)

Description:

Uploads the specified object and its contained objects into the database, given the upload information in parameters. This command returns only when the Upload Request has finishes processing. If an error occurs, the UROld is set to "".

Parameters:

parameters--these are equipment module specific

Network Element Factory Interface

Network Element Factory is derived from Persistent Factory. The network element factory interface is implemented through the following operations (also called methods):

create network element

Usage:

NetworkElement createNetworkElement (in ClassId nptClassName) raises (NptException)

Description:

Create a network element.

Parameters:

nptClassName--the classname, defined in the OAF

bind network element

Usage:

NetworkElement bindNetworkElement (in PersistentId id) raises (NptException)

Description:

This operation passes an object id for the network element into the bind and it will give you a CORBA object reference for the network element.

Parameters:

id--specifies the persistent object ID

Persistent Interface

The persistent interface is implemented through the following operations (also called methods).

is new

Usage:

boolean is New () raises (NptException)

Description:

If this operation returns TRUE this is a new object, FALSE otherwise.

get persistent ID

Usage:

PersistentId getPersistentId () raises (NptException)

Description:

Get persistent ID for the object.

set parent

Usage:

void setParent (in PersistentId parent) raises (NptException)

Description:

Set the parent.

Parameters:

parent

get mode

Usage:

Mode getMode (in AttributeName attributeName) raises (NptException)

Description:

Get the mode for the specified attribute. If the object has an associated profile, then the mode is defined by the profile for profiled attributes.

get value

Usage:

AttributeValue getValue (in AttributeName attributeName) raises (NptGetValueException, NptException)

Description:

This operation gets the modified value of the specified attribute. The modified version is the version of the object in memory which can not yet been saved

overwrite value

Usage:

ovid overwriteValue (in AttributeName attributeName, in AttributeValue attributeValue) raises (NptException)

Description:

This operation sets the values of the specified attributes without checking for mode of the attributes.

Parameters:

attributeName--the attribute name

attributeValue--the attribute value

get attributes

Usage:

void getAttributes (in AttributeItemSeq attributes, out AttributeValueItemSeq results) raises (NptException)

Description:

Provides the user with a mechanism for getting the values for a specified set of object attributes.

get attributes and mode

Usage:

void getAttributesandMode(in AttributeItemSeq attributes, out AttributeValueandModeItemSeq results) raises (NptException)

Description:

Provides the user with a mechanism for getting the values for a specified set of object attributes and their associated modes.

get attributes and GUI mode

Usage:

void getAttributesGuiMode (in AttributeItemSeq attributes, out AttributeValueandGuiModeItemSeq results) raises (NptException)

Description:

Provides the user with a mechanism for getting the values for a specified set of object attributes and their GUI modes.

set attributes

Usage:

void setAttribute (in AttributeValueItemSeq attributeList, out raises (NptException)

Description:

Provides the user with a mechanism for setting the values for a specified set of object attributes. The value of the attributes are set in memory but not into the database until a save is done.

Parameters:

attributeList--attribute list

overwrite attributes

Usage:

void overwriteAttributes (in AttributeValueItemSeq attributeList) raises (NptException)

Description:

This operation sets the values of the specified attributes without checking for the mode of the attributes.

Parameters:

attributeList--attribute list

set assocaition by name

Usage:

void setAssociationByName (in AttributeName attributeName) raises (NptException)

Description:

Set association by criteria.

Parameters:

attributeName--the attribute name

criteria

get permitted actions

Usage:

void getPermittedActions (in ActionItemSeq actions, out PermissionItemSeq permission) raises (NptException)

Description:

Provides the user with a mechanism for determining whether or not a set of actions is permitted. This is typicall used by viewers and scripters.

get reason not permitted

Usage:

string getReasonNotPermitted (in string actionName, out ErrorNumber number) raises (NptException)

Description:

This operation returns the reason why the action is not permitted.

Parameters:

actionName--This is the specified action (for example, getList action)

number--This is the returned error number of the reason.

integrated request

Usage:

void intergratedRequest (in string command, in string inputParameters, out string outputParameter) raises (NptException)

Description

This is a generic method interface, behavior is instance specific.

Parameters:

command--the command name

inputParameter--one input string parameter for the command

outputParameter--one output string parameter for the command

get translated text

Usage:

string getTranslatedText (in string text) raises (NptException)

Description:

Provides the user with a mechanism for translating (coverting) a text string. This is typically used by viewers to create the window title.

Parameters:

text--text string.

undo

Usage:

void undo () raises (NptException)

Description:

Provides the user with a mechanism for undoing all setAttributes since the last save for this object. This method instructs the object to throw away changes that have not been saved.

save

Usage:

void save (inout AttributeErrorItemSeq errorList) raises (NptException, NptSave Exception)

Description:

Provides the user with a mechanism for saving all object changes to the database that were done with the setAttributes operation. The errorList parameter is normally not used.

remove

Usage:

void remove (inout AttributeErrorItemSeq errorList raises (NptException, NptSaveException)

Description:

Provides the user with a mechanism for removing (deleting) the object. The errorList parameter is normally not used.

Persistent Factory Interface

The persistent factory interface is implemented through the following operations (also called methods):

create object

Usage:

Persistent createObject (in ClassId, nptClassName) raises (NptException)

Description:

Create object.

Parameters:

nptClassName--the classname, defined in the OAF

bind object

Usage:

Persistent bindObject (in PersistentId id) raises (NptException)

Description:

This operation passes on an object id for the object into the bind and it will give you a CORBA object reference for the object.

Parameters:

id--ID of the object

get object class

Usage:

ClassId getObjectClass (in PersistentId id) raises (NptException)

Description:

Get object class

Parameters:

id--ID of the object

create lister

Usage:

Lister CreateLister (in ClassIf nptClassName) raises (NptException)

Description:

Create lister for the specified class name.

Parameters:

nptClassName--the classname, defined in the OAF.

bind lister

Usage:

Lister bindLister (in ObjectId id) raises (nptException)

Description:

This operation passes an object id for the lister into the bind and it will give you a CORBA object reference for the lister.

Parameters:

id--ID of the lister.

create new site item lister

Usage:

SiteItemLister createSiteItemLister (in objectId coid) raises (NptException)

Description:

Create site item lister for the specified object ID.

Parameters:

coid--This specifies the Transaction or change order object id.

Managed Interface

Managed is derived from Persistent. Managed adds the following methods:

revert

Usage:

void revert (inout AttributeErrorItemSeq errorList) raises (NptException, NptSaveException)

Description:

Provides the user with a mechanism for reverting changes to the object. An object reverts by deleting all of its pending records.

Parameters:

errorList--normally not used get pending operation

get pending operation

Usage:

void getPendingOperation () raises (NptException)

Description:

Gets the pending operation for the object. See SYcrbNPT::PendingOperation for return enum.

Parameters:

seekOffset--the index into the file of the first byte to be returned

nBytes--the number of bytes form seekOffset forward to be read for the file.

data--the requested bytes from the file.

returnvalue--the actual number of bytes returned.

Log File Server Interface

The Log File Server interface provides read access to Cisco Provisioning Center log files.

read

Usage:

unsigned long read (in string fileName, in long seekOffset, in unsigned long nBytes, out charSeq data) raises (NptException)

Description:

read log file by name.

Parameters:

filename--the name of the file relative to the $CCP_REL/log directory

readAudit

Usage:

unsigned long readAudit (in long crId, in long seekOffset, in unsigned long nBytes, out charSeq data) raises (NptException)

Description:

Read audit log file by Transaction number.

Parameters

crld--the Transaction number

readSite

Usage:

unsigned long readSite (in long CrId, in string siteName, in long seekOffset, in unsigned long nBytes, out charSeq data) raises (NptException)

Description:

Read site log file by site name and Transaction number.

Parameters:

crld--the Transaction number

siteName--the site name

readSiteError

Usage:

unsigned long readSite (in long CrId, in string siteName, in long seekOffset, in unsigned long nBytes, out charSeq data) raises (NptException)

Description:

Read site error log file by site name and Transaction number.

Parameters:

crId--The transaction number

siteName--the site name

readEvent

Usage:

unsigned long readEvent (in long seeOffset, in unsigned long nBytes, out charSeq data) raises (NptException)

Description:

Read the event file.

readSystemAdmin

Usage:

unsigned long readSystemAdmin (in long seekOffset, in unsigned long nBytes, out charSeq data) raises (NptException)

Description:

Read the system admin file.

Ready State	"Ready"
Current State	"Current"
Busy State	"Busy"
Scheduled State	"Scheduled"
Applied State	"Applied"
Alert State	"Alert"
Abandoned State	"Abandoned"

CHOOSE_ACTION	"CHOOSE"
DISPLAY_ACTION	"DISPLAY"
GETLIST_ACTION	"GETLIST"
NEW_ACTION	"NEW"
REMOVE_ACTION	"REMOVE"
SAVE_ACTION	"SAVE"
UNDO_ACTION	"UNDO"
UPLOAD_ACTION	"UPLOAD"
VIEW_ACTION	"VIEW"
ZOOM_ACTION	"ZOOM"

SY_OBJECTID_COLUMN	"sy_objectid"
SY_RETURNOID_COLUMN	"sy_returnid"
SY_CREATEDATE_COLUMN	"sy_createdate"
SY_MODIFIEDDATE_COLUMN	"sy_modifieddate"
SY_SEQUENCENUMBER_COLUMN	"sy_sequencenumber"

CURRENT_COID_ATTRIBUTE	"current_coid"
CURRENT_CRNUMBER_ATTRIBUTE	"current_crnumber"
PENDING_OPERATION_ATTRIBUTE	"pending_operation"
PENDING_STATUS_ATTRIBUTE	"pending_status"

CURRENT_NO_PENDING_STATUS	"CURRENTNOPENDING"
CURRENT_WITH_PENDING_STATUS	"CURRENTWITHPENDING"
CURRENT_WITH_INVALID_PENDING_STATUS	"PENDING"
INVALID_PENDING_STATUS	"INVALID"

CURRENT_VERSION	"0"
CURRENT_VERSION_NUM	0
PENDING_VERSION	"1"
PENDING_VERSION_NUM	1

ADD_PENDING_OPERATION	"0"
ADD_PENDING_OPERATION_NUM	0
MODIFY_PENDING_OPERATION	"1"
MODIFY_PENDING_OPERATION_NUM	1
DELETE_PENDING_OPERATION	"2"
DELETE_PENDING_OPERATION_NUM	2
RELOAD_PENDING_OPERATION	"3"
RELOAD_PENDING_OPERATION_NUM	3
NO_PENDING_OPERATION	"4"
NO_PENDING_OPERATION_NUM	4
NEW_PENDING_OPERATION	"5"
NEW_PENDING_OPERATION_NUMB	5

typedef	string	ObjectId
typedef	string	ClassId
typedef	long	DbId
typedef	string	AttributeName
typedef	string	AttributeValue
typedef	long	ErrorNumber
typedef	string	ErrorText
typedef	ObjectId	PersistentId
typedef	string	AttributeItem
typedef	string	AttributeResultItem
typedef	string	UniqueByItem
typedef	sequence<char>	charSeq;
typedef	sequence<string>	stringSeq;
typedef	sequence<ObjectId>	ObjectIdSeq;
typedef	sequence<AttributeValueItem>	AttributeValueItemSeq;
typedef	sequence<AttributeValueAndModeItem>	AttributeValueAndModeItemSeq
typedef	sequence<AttributeValueAndGuiModeItem>	AttributeValueAndGuiModeItemSeq;
typedef	sequence<ActionItem>	ActionItemSeq;
typedef	sequence<PermissionItem>	PermissionItemSeq;
typedef	sequence<UpLoadItem>	UpLoadItemSeq;
typedef	sequence<SubtypeItem>	SubtypeItemSeq;
typedef	sequence<AttributeError>	AttributeErrorItemSeq;
typedef	sequence<SearchItem>	SearchItemSeq;
typedef	sequence<AttributeItem>	AttributeItemSeq;
typedef	sequence<AttributeResultItem>	AttributeResultItemSeq;
typedef	sequence<AttributeResultItemSeq>	AttributeResultItemSeqSeq;
typedef	sequence<OrderByItem>	OrderByItemSeq;
typedef	sequence<UniqueByItem>	UniqueByItemSeq;
typedef	sequence<ErrorMessage>	ErrorMessageSeq;
typedef	sequence<MVCEvent>	MVCEventSeq;
typedef	long	EventSourceId;
typedef	sequence<EventSourceId>	EventSourceIdSeq;

string	evenClass	"CMS" for fabric and service element object,"CCS" for transaction and upload request objects
string	eventType	one of the "new", "modify", "delete", "revert", "commit", "reject"
ObjectIdSeq	modeIds	ObjectIdSeqmodelIds - a sequence of objects ids of the object changed
string	parameters	string parameters contain the number of the foreground or background session where the change originated; when intraSession events are enabled significant events in other sessions will be delivered with a parameter of "0"

AttributeName	name	name of the errored attribute
ErrorNumber	number	error number
ErrorText	text	message describing why the value of this attribute is in error

string	vendor	the vendor of the software that generated the error (SY for Syndesis)
string	application	the name of a software application process
string	pid	the UNIX process where the error was generated
string	subsystem	the name of a software subsystem
Severity	severity
verbosity	verbosity
objectId	objectId	the object id of the object being processed when the error occurred
ErrorNumber	ident	an error number
ErrorText	message	a printable error message

ErrorNumber	status	an error number
Category	category	an error category
ErrorMessageSeq	errors	a sequence of error messages

SYcrbNPT::ErrorNumber	status
SYcrbNPT::ErrorMessageSeq	errors
SYcrbNPT::AttributeErrorItemSeq	failedAttributes-describes the attributes that prevented the object from being saved

SYcrbNPT::Category	category
SYcrbNPT::ErrorText	message
AVExceptionDetails	details
CRID	abandonedTransactionId

get all attributesWithModes
Usage:	void getAllAttributesWithModes (in SOID id, in TransactionMode transactionMode, inout CRID transactionId, out SYcrbNPT::AttributeValueAndItemSeq soAttributesAndModes, raises (AVAutoTransactionException)
Description:	Same as the get AllAttributes command, except this command also returns the attribute modes of the given Service object. The Service object must be specified using the object id in the SOID id input parameter.

get all profile attributes
Usage	void getAllProfileAttributes (in SOID id, in TransactionMode transactionMode, inout CRID transactionId, out SYcrbNPT::AttributeValueAndModeItemSeq profileAttributes) raises AVAutoTransactionException)
Description:	Returns the attribute values and modes of the given Service profile. The Service profile must be specified using the object id in the SOID id input parameter.

linkFail
Usage:	void linkFail (in LINKID link) raises (AVException)
Description:	Re-threads the circuits running over the specified failed link. This command returns when it either succeeds or fails.
Parameters:	link--ID of the link

linkRecover
Usage:	void linkRecover (in LINKID link) raises (AVException)
Description:	Restores the specified recovered link. This command returns when it either suceeds or fails.
Parameters:	link--ID of the link

linkRebalance
Usage:	void linkRebalance (in LINKID link) raises (AVException)
Description:	Re-balances the load across links in the same group as the indicated link. This command returns when it either suceeds or fails.
Parameters	link--ID of the link

unifail
Usage:	void unifail (in LPNAME logical port name) raises (AVException)
Description:	Fails a foreground logical port. This command returns when it either suceeds or fails.
Parameters:	logical port name--name of the Logical Port name

Table of Contents