Cisco Cisco Prime Optical 9.8 Technical References
MTNM IMPLEMENTATION STATEMENT TEMPLATES AND GUIDELINES
string>
operation2
…
Conventions:
Status – an indication of whether or not the operation is mandatory for a particular interface, as defined in the
IDL. The status of an operation can be determined from the IDL. If the exception
“EXCPT_NOT_IMPLEMENTED” is among the allowable exceptions for an operation, then the operation is
optional. In this case, an “O” would be placed in the Status field. Otherwise, the operation is mandatory (this is
indicated by an “M”).
IDL. The status of an operation can be determined from the IDL. If the exception
“EXCPT_NOT_IMPLEMENTED” is among the allowable exceptions for an operation, then the operation is
optional. In this case, an “O” would be placed in the Status field. Otherwise, the operation is mandatory (this is
indicated by an “M”).
Support – an indication of whether or not an operation is supported by an EMS vendor (required by a service
provider). “Y” is used to indicate the operation is supported (required), “N” is used to indicate the operation is not
support (not required) and “C” is used if support for an operation is conditional (in this case, an explanation
should be included). Note that “Support” field is different than the mandatory/optional indications derived from the
IDL. If the implementation statement is prepared by a service provider, the “support” field could be used to
indicate a need for capabilities that are implied to be optional in the IDL. Alternately, a vendor could use the
“support” field to indicate the MTNM capabilities that they support in their product.
provider). “Y” is used to indicate the operation is supported (required), “N” is used to indicate the operation is not
support (not required) and “C” is used if support for an operation is conditional (in this case, an explanation
should be included). Note that “Support” field is different than the mandatory/optional indications derived from the
IDL. If the implementation statement is prepared by a service provider, the “support” field could be used to
indicate a need for capabilities that are implied to be optional in the IDL. Alternately, a vendor could use the
“support” field to indicate the MTNM capabilities that they support in their product.
Exception/Error Reason – a list of the vendor-specific error reason strings on an operation/exception basis.
Recall the MTNM interface provides an error reason field for each exception. It is up to the EMS vendor to
decide on the contents of the error reason field. If the error reason strings are long, they can be listed and
numbered elsewhere, and then cross-referenced from the table.
Recall the MTNM interface provides an error reason field for each exception. It is up to the EMS vendor to
decide on the contents of the error reason field. If the error reason strings are long, they can be listed and
numbered elsewhere, and then cross-referenced from the table.
Comments – this field is used by the EMS vendor to state specific behavioral peculiarities of their implementation
of the operation, e.g., to indicate that a particular operation parameter is not supported.
of the operation, e.g., to indicate that a particular operation parameter is not supported.
Many of the interfaces have corresponding iterator interfaces. The iterator interfaces are used for the bulk
retrieval of data. All of the iterator interfaces have the same operations.
retrieval of data. All of the iterator interfaces have the same operations.
Table Error! No text of specified style in document.-3. General Iterator Interface
Operation Status
Support
Exception/
Error Reason
Comments
destroy
M
getLength M
next_n M
2.1.4
Operations
The operations template (shown in Table Error! No text of specified style in document.-4) is be used when an
organization (that is creating a profile of TMF 814) needs to further define characteristics and/or behavior for an
operation (beyond that specified in the interface template). A blank cell in the following table implies that the
organization completing the template has no further information to provide with regard to the
Parameter/Characteristic.
organization (that is creating a profile of TMF 814) needs to further define characteristics and/or behavior for an
operation (beyond that specified in the interface template). A blank cell in the following table implies that the
organization completing the template has no further information to provide with regard to the
Parameter/Characteristic.
The Comments/Clarifications column is used to further clarify the characteristics and/or usage of the parameter.
One can use this column (for example) to indicate the maximum supported length of a parameter, and the
default value for a parameter.
One can use this column (for example) to indicate the maximum supported length of a parameter, and the
default value for a parameter.
It is not anticipated that this template will be needed for all operations.
Table Error! No text of specified style in document.-4. Operations Template Example - createAndActivateSNC
TMF814Av3.1
TeleManagement Forum 2007
Page 17 of 115