|
|
The file SYcrbAV.idl contains the following interfaces:
SYcrbAV::NNIResiliencyManager SYcrbAV::ServiceObjectManager SYcrbAV::Session SYcrbAV::SessionFactory SYcrbAV::TransactionManager
This module provides access to the management functions of the product. This includes the following areas: Service object management, NNI resiliency management, Transaction management, and Session management.
Represents the attribute specification types.
Usage
typedef sequence<SYcrbNPT::AttributeValueItemSeq> AttributeValueItemSeqSeq
Uses AVExceptionDetailTypes as a discriminator to select between one of AVStackExceptionDetails, AVSaveExceptionDetails, AVNumberExceptionDetails, or AVUnNumberedExceptionDetails.
Usage
union AVExceptionDetails switch (AVExceptionDetailTypes)
{
case StackDetails:
AVStackExceptionDetails stack;
case SaveDetails:AVSaveExceptionDetails save;
case NumberedDetails:AVNumberedExceptionDetails numbered;
case UnNumberedDetails:AVUnNumberedExceptionDetails unNumbered;
};
Members
AVStackExceptionDetails stack.
AVSaveExceptionDetails save.
AVNumberedExceptionDetails numbered.
AVUnNumberedExceptionDetails unNumbered.
Represents the exception detail types.
Usage
enum AVExceptionDetailTypes
{
StackDetails,
SaveDetails,
NumberedDetails,
UnNumberedDetails
};
Enumerators
StackDetails represents the stack details.
SaveDetails represents the save details.
NumberedDetails represents the numbered details.
UnNumberedDetails represents the unnumbered details.
Corresponds to a numbered exception and derived classes.
Usage
struct AVNumberedExceptionDetails
{
SYcrbNPT::ErrorNumber status;
string exceptionClass;
};
Members
status--SYcrbNPT::ErrorNumber that represents the error number.
exceptionClass--string that represents the exception class.
Corresponds to NptSaveException.
Usage
struct AVSaveExceptionDetails
{
SYcrbNPT::ErrorNumber status;
SYcrbNPT::ErrorMessageSeq errors;
SYcrbNPT::AttributeErrorItemSeq failedAttributes;
};
Members
status--SYcrbNPT::ErrorNumber that represents the error number.
errors--SYcrbNPT::ErrorMessageSeq that represents the error message.
failedAttributes--SYcrbNPT::AttributeErrorItemSeq that represents the failed attributes.
Corresponds to NptException.
Usage
struct AVStackExceptionDetails
{
SYcrbNPT::ErrorNumber status;
SYcrbNPT::ErrorMessageSeq errors;
};
Members
status--SYcrbNPT::ErrorNumber that represents the error number.
errors--SYcrbNPT::ErrorMessageSeq that represents the error message.
Correponds to a standard Java exception (class name stored in exception class).
Usage
struct AVUnNumberedExceptionDetails
{
string exceptionClass;
};
Members
exceptionClass--string that represents the exception class.
Represents the Transaction ID. A Transaction is identified by its NPT Change Request (CR) persistent ID.
Usage
typedef SYcrbNPT::PersistentId CRID
Represents the Link ID. A link is identified by its NPT persistent ID.
Usage
typedef SYcrbNPT::PersistentId LINKID
Represents the Service object ID. A Service object is identified by its NPT persistent ID.
Usage
typedef SYcrbNPT::PersistentId SOID
Represents the Transaction mode. The Transaction mode can be one of the following:
Usage
enum TransactionMode
{
Atomic,
Auto,
Current,
Open,
Specified,
None
};
Enumerators
Atomic 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 Uses the Transaction that is open in the current session if there is one, and automatically creates and opens one if not.
Current 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 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 session, where the Operator might unexpectedly close the Transaction.
Specified Works within the Transaction specified by the given CRID. If that Transaction is already open in the session then it is used. If that Transaction is open in another session or another Transaction is open in the current session then an error is thrown. If no Transaction is open, then the product opens the specified Transaction for the session.
This is an exception for those methods that can auto-create a Transaction.
Usage
exception AVAutoTransactionException
{
SYcrbNPT::Category category;
SYcrbNPT::ErrorText message;
AVExceptionDetails details;
CRID abandonedTransactionId;
};
This is a basic exception.
Usage
exception AVException
{
SYcrbNPT::Category category;
SYcrbNPT::ErrorText message;
AVExceptionDetails details;
};
This interface provides access to the link fail, recover, and rebalance operations.
Re-threads the circuits running over the specified failed link. This command returns when it either succeeds or fails.
Usage
void linkFail(in LINKID link)
raises(AVException);
Parameters
link--in LINKID link object ID.
Raises
AVException
Re-balances the load across links in the same group as the indicated link. This command returns when it either succeeds or fails.
Usage
void linkRebalance(in LINKID link)
raises(AVException);
Parameters
link--in LINKID link object ID.
Raises
AVException
Restores the specified recovered link. This command returns when it either succeeds or fails.
Usage
void linkRecover(in LINKID link)
raises(AVException);
Parameters
link--in LINKID link object ID.
Raises
AVException
This interface provides access to the methods for creating, modifying, deleting, and retrieving information about Service objects.
Creates a new Service object with the given attributes.
Usage
SOID create(in TransactionMode transactionMode, inout CRID transactionId, in SYcrbNPT::AttributeValueItemSeq transactionAttributes, inout SYcrbNPT::AttributeValueItemSeq soAttributes)
raises(AVAutoTransactionException);
Parameters
transactionMode--in TransactionMode object from which to get a transaction mode.
transactionId--inout CRID object from which to get a Transaction ID.
transactionAttributes--in SYcrbNPT::AttributeValueItemSeq object from which to get the Transaction attributes (one or more of briefdescription, domain, and vpn).
soAttributes--inout SYcrbNPT::AttributeValueItemSeq object from which to get the Service object attributes.
Returns
SOID representing the Service Object ID.
Raises
AVAutoTransactionException
Description
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.
Deletes the given Service object. The Service object must be specified using the object id in the SOID id input parameter.
Usage
void del(in SOID id, in TransactionMode transactionMode, inout CRID transactionId, in SYcrbNPT::AttributeValueItemSeq transactionAttributes, out SYcrbNPT::AttributeValueItemSeq soAttributes)
raises(AVAutoTransactionException);
Parameters
id--in SOID object from which to get the Service object ID.
transactionMode--in TransactionMode object from which to get a transaction mode.
transactionId--inout CRID object from which to get a Transaction ID.
transactionAttributes--in SYcrbNPT::AttributeValueItemSeq object from which to get the Transaction attributes (one or more of briefdescription, domain, and vpn).
soAttributes--out SYcrbNPT::AttributeValueItemSeq object from which to get the Service object attributes.
Raises
AVAutoTransactionException
This is a generic method interface, behavior is instance specific.
Usage
void genericRequest(in TransactionMode transactionMode, inout CRID transactionId, in SYcrbNPT::AttributeValueItemSeq transactionAttributes, in string methodName, inout string methodParameters)
raises(AVAutoTransactionException);
Parameters
transactionMode--in TransactionMode object from which to get a transaction mode.
transactionId--inout CRID object from which to get a Transaction ID.
transactionAttributes--in SYcrbNPT::AttributeValueItemSeq object from which to get the Transaction attributes (one or more of briefdescription, domain, and vpn).
methodName--in string object from which to get the method name.
methodParameters--inout string object from which to get the method parameters.
Raises
AVAutoTransactionException
Returns the attributes of the given Service object.
Usage
void getAllAttributes(in SOID id, in TransactionMode transactionMode, inout CRID transactionId, out SYcrbNPT::AttributeValueItemSeq soAttributes)
raises(AVAutoTransactionException);
Parameters
id--in SOID object from which to get the Service object ID.
transactionMode--in TransactionMode object from which to get a transaction mode.
transactionId--inout CRID object from which to get a Transaction ID.
soAttributes--out SYcrbNPT::AttributeValueItemSeq object from which to get the Service object attributes.
Raises
AVAutoTransactionException
Same as the getAllAttributes 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 (Service object id) input parameter.
Usage
void getAllAttributesWithModes(in SOID id, in TransactionMode transactionMode, inout CRID transactionId, out SYcrbNPT::AttributeValueAndModeItemSeq soAttributesAndModes)
raises(AVAutoTransactionException);
Parameters
id--in SOID object from which to get the Service object ID.
transactionMode--in TransactionMode object from which to get a transaction mode.
transactionId--inout CRID object from which to get a Transaction ID.
soAttributesAndModes--out SYcrbNPT::AttributeValueAndModeItemSeq object from which to get the Service object attributes.
Raises
AVAutoTransactionException
Returns the attribute values and modes of the given Service profile. The Service profile must be specified using the object id in the SOID (Service Object id) input parameter.
Usage
void getAllProfileAttributes(in SOID id, in TransactionMode transactionMode, inout CRID transactionId, out SYcrbNPT::AttributeValueAndModeItemSeq profileAttributes)
raises(AVAutoTransactionException);
Parameters
id--in SOID object from which to get the Service object ID.
transactionMode--in TransactionMode object from which to get a transaction mode.
transactionId--inout CRID object from which to get a Transaction ID.
profileAttributes--out SYcrbNPT::AttributeValueAndModeItemSeq object from which to get the profile attributes.
Raises
AVAutoTransactionException
Returns the list of components associated with a given Service object. The Service object must be specified using the object id in the SOID (Service object id) input parameter.
Usage
void getDetails(in SOID id, in TransactionMode transactionMode, inout CRID transactionId, out AttributeValueItemSeqSeq detailsAttributes)
raises(AVAutoTransactionException);
Parameters
id--in SOID representing the Service object ID.
transactionMode--in TransactionMode object from which to get a transaction mode.
transactionId--inout CRID object from which to get a Transaction ID.
detailsAttributes--out AttributeValueItemSeqSeq
Raises
AVAutoTransactionException
Returns the attributes of the given Service object.
Usage
void listAllAttributes(in TransactionMode transactionMode, inout CRID transactionId, in SYcrbNPT::AttributeValueItemSeq criteria, out AttributeValueItemSeqSeq results)
raises(AVAutoTransactionException);
Parameters
transactionMode--in TransactionMode object from which to get a transaction mode.
transactionId--inout CRID object from which to get a Transaction ID.
criteria--in SYcrbNPT::AttributeValueItemSeq specifies the search criteria, including: 1. 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. 2. 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.
results--out AttributeValueItemSeqSeq
Raises
AVAutoTransactionException
Returns the attribute values and modes of the given Service profile. The Service profile must be specified using the object id in the SOID (Service object id) input parameter.
Usage
void listAllProfileAttributes(in TransactionMode transactionMode, inout CRID transactionId, in SYcrbNPT::AttributeValueItemSeq criteria, out AttributeValueItemSeqSeq results)
raises(AVAutoTransactionException);
Parameters
id--in SOID object from which to get the Service object ID.
transactionMode--in TransactionMode object from which to get a transaction mode.
transactionId--inout CRID object from which to get a Transaction ID.
criteria--in SYcrbNPT::AttributeValueItemSeq specifies the search criteria, including: 1. 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. 2. 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.
results--out AttributeValueItemSeqSeq
Raises
AVAutoTransactionException
Modifies a Service object with the given attributes.
Usage
void modify(in SOID id, in TransactionMode transactionMode, inout CRID transactionId, in SYcrbNPT::AttributeValueItemSeq transactionAttributes, inout SYcrbNPT::AttributeValueItemSeq soAttributes)
raises(AVAutoTransactionException);
Parameters
transactionMode--in TransactionMode object from which to get a transaction mode.
transactionId--inout CRID object from which to get a Transaction ID.
transactionAttributes--in SYcrbNPT::AttributeValueItemSeq object from which to get the Transaction attributes (one or more of briefdescription, domain, and vpn).
soAttributes--inout SYcrbNPT::AttributeValueItemSeq object from which to get the Service object attributes.
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.
This interface provides access to the methods for creating and managing sessions.
This interface provides access to the methods for creating and managing sessions.
This interface provides access to the methods for opening, closing, applying, abandoning, and deleting Transactions.
Abandons the Transaction. This command waits until the Transaction is abandoned.
Usage
void abandon(in CRID id)
raises(AVException);
Parameters
id--in CRID object from which to get a Transaction ID.
Raises
AVException
Applies the Transaction to the network. This command waits until the Transaction either succeeds to the Applied state or fails to the Abandoned state.
Usage
void apply(in CRID id)
raises(AVException);
Parameters
id--in CRID object from which to get a Transaction ID.
Raises
AVException
Closes a previously opened Transaction.
Usage
void close(in CRID id)
raises(AVException);
Parameters
id--in CRID object from which to get a Transaction ID.
Raises
AVException
Creates a new Transaction but does not open it. This command returns the object id of the Transaction.
Usage
CRID create(in SYcrbNPT::AttributeValueItemSeq attributes)
raises(AVException);
Parameters
attributes--in SYcrbNPT::AttributeValueItemSeq object used to select the Transaction attributes. It can be one of the following: briefdescription, domain, vpn.
Returns
CRID representing the Transaction ID.
Raises
AVException
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 Ready state. Delete is possible from the Ready and Current states.
Usage
void del(in CRID id)
raises(AVException);
Parameters
id--in CRID object from which to get a Transaction ID.
Raises
AVException
Provides the user with a mechanism for getting all attributes of a Transaction.
Usage
void getAllAttributes(in CRID id, out SYcrbNPT::AttributeValueItemSeq attributes)
raises(AVException);
Parameters
id--in CRID object from which to get a Transaction ID.
attributes--out SYcrbNPT::AttributeValueItemSeq returns the attribute names and values.
Raises
AVException
Provides the user with a mechanism for getting the values for a specified set of object attributes and their associated modes.
Usage
void getAttributes(in CRID id, in SYcrbNPT::AttributeItemSeq attributeNames, out SYcrbNPT::AttributeValueItemSeq attributes)
raises(AVException);
Parameters
id--in CRID object from which to get a Transaction ID.
attributeNames--in SYcrbNPT::AttributeItemSeq specifies the attribute names.
attributes--out SYcrbNPT::AttributeValueItemSeq returns the attribute names and values.
Raises
AVException
Lists Transactions and returns all of the attributes of matching objects.
Usage
void listAllAttributes(in SYcrbNPT::AttributeValueItemSeq criteria, out AttributeValueItemSeqSeq results)
raises(AVException);
Parameters
criteria--in SYcrbNPT::AttributeValueItemSeq specifies the search criteria, including: 1. 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. 2. 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.
results--out AttributeValueItemSeqSeq
Raises
AVException
Opens a Transaction.
Usage
void open(in CRID id)
raises(AVException);
Parameters
id--in CRID object from which to get a Transaction ID.
Raises
AVException
Provides the user with a mechanism for modifying the value of briefdescription, domain, and vpn.
Usage
void setAttributes(in CRID id, in SYcrbNPT::AttributeValueItemSeq attributes)
raises(AVException);
Parameters
id--in CRID object from which to get a Transaction ID.
attributes--out SYcrbNPT::AttributeValueItemSeq returns the attribute names and values.
Raises
AVException
Starts a new Transaction with the given Brief Description, Management Domain (MD), and Virtual Private Network (VPN). This command creates a new Transaction, opens it and then returns the object id of the Transaction.
Usage
CRID start(in SYcrbNPT::AttributeValueItemSeq attributes)
raises(AVException);
Parameters
attributes--in SYcrbNPT::AttributeValueItemSeq object used to select the Transaction attributes. It can be one of the following: briefdescription, domain, vpn.
Returns
CRID representing the Transaction ID.
const string AbandonedState = "Abandonded" const string AlertState = "Alert" const string AppliedState = "Applied" const string BusyState = "Busy" const string CurrentState = "Current" const string ReadyState = "Ready"
Posted: Thu Aug 3 16:33:15 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.