tmf854.v1 > getContainedInUseCTPs_T LOCATION: file:/xsd/interfaces/ManagedElementMgr.xsd
SECTIONS: Basic | XML Instance | Attributes | XML | Reference Overview | TOC | No TOC | Help
tmf854.v1
The getContainedInUseCTPs_T Complex Type
This service is used to retrieve the "in use" CTPs that are contained within a specific PTP, FTP or CTP, at specific layer rates. An "in use" CTP is defined as a CTP that is used by an SNC in any state (including pending), either as a CM end point or as an intermediate connection point, or a CTP that is terminated and mapped. This operation will be used when there are a large number of potential CTPs (e.g., in ATM). Example of usage with respect to ATM: To retrieve all actual ATM Network Interfaces associated with a PTP, this operation will be invoked using the PTP name as the tpName and LR_ATM_NI as the only layer rate in the layerRateList. The VPI and VCI ranges that are specified in the returned ATM Network Interface transmissionParams (i.e., Max_VPI_Bits and Max_VCI_Bits) can then be used to determine the potential VPI/VCI range. A subsequent invocation of this operation using an ATM Network Interface CTP as input can be used to determine which VPIs/VCIs are actually in use (with LR_ATM_VP and LR_ATM_VC included in the connectionRateList). Example of usage with respect to SONET/SDH: Consider an STM4 PTP with layerRate: LR_Optical_OC12_and_STM4. Assume that the set of CTPs returned by operation getContainedPotentialTPs() contains one CTP with layerRate LR_STS3c_and_AU4_VC4 that is terminating an SNC (layerRate LR_STS3c_and_AU4_VC4), and another CTP with layerRate LR_STS3c_and_AU4_VC4 that is terminated and mapped (attribute tpMappingMode is set to TM_TERMINATED_AND_AVAILABLE_FOR_MAPPING). The CTP with layerRate LR_STS3c_and_AU4_VC4 that is terminated and mapped contains one CTP with layerRate LR_VT2_and_TU12_VC12 that is involved in an SNC. None of the other contained CTPs have attribute tpMappingMode set to TM_TERMINATED_AND_AVAILABLE_FOR_MAPPING, or are involved in an SNC. Operation getContainedInUseTPs then returns three CTPs: - The CTP with layerRate LR_STS3c_and_AU4_VC4 that is terminating an SNC. - The CTP with layerRate LR_STS3c_and_AU4_VC4 that has attribute tpMappingMode set to TM_TERMINATED_AND_AVAILABLE_FOR_MAPPING. - The CTP with layerRate LR_VT2_and_TU12_VC12 that is terminating an SNC. Refer to the TMF 854 XML Solution Set document for details on the Message Exchange Pattern controls (multiple batch response). Raises ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of non-specific OS internal failure EXCPT_INVALID_INPUT - Raised when tpName does not reference a PTP, FTP or CTP object or layerRateList contains undefined rates EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a PTP, FTP or CTP object that does not exist EXCPT_COMM_FAILURE - Raised when communication to an entity (needed to help fulfill the request) is lost

Local elements (2)
  tpName layerRateList

Complex Type getContainedInUseCTPs_T
The getContainedInUseCTPs_T type does not allow mixed content. There is no restriction on type derivation.

XML Instance
<... extAuthor="xsd:string" extVersion="xsd:string" tmf854Version="TMF854_Version_T"> -Begin Sequence [1...1] The name of the TP for which to get contained in use TPs. The termination point name must be explicit (a generic endpoint specification may not be used in this case). See Object Naming for further detail on FTP naming. <tpName extVersion="xsd:string" extAuthor="xsd:string" tmf854Version="TMF854_Version_T">NamingAttributes_T</tpName> [1..1] The list of rates of the contained in use CTPs to be returned. An empty list indicates to get all contained in use CTPs (of all rates). <layerRateList extAuthor="xsd:string" extVersion="xsd:string" tmf854Version="TMF854_Version_T">LayerRateList_T</layerRateList> [0..1] End Sequence </...>

﻿

Attributes |
﻿
Name | Type | Summary
--- | --- | ---
extAuthor | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extAuthor is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
extVersion | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extVersion is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
tmf854Version | TMF854_Version_T | This attribute is optional. Its form is unqualified. Show details.
Base type of tmf854Version is string. There are several restrictions on the value. The schema processor preserves value's whitespace. The value must match "`1\.([0-9]|[A-Z]|[a-z])*`".
﻿
Name | Type | Summary
--- | --- | ---
extAuthor | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extAuthor is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
extVersion | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extVersion is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
tmf854Version | TMF854_Version_T | This attribute is optional. Its form is unqualified. Show details.
Base type of tmf854Version is string. There are several restrictions on the value. The schema processor preserves value's whitespace. The value must match "`1\.([0-9]|[A-Z]|[a-z])*`".
﻿
Name | Type | Summary
--- | --- | ---
extAuthor | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extAuthor is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
extVersion | string | This attribute is optional. Its form is unqualified. Show details.
Base type of extVersion is string. There are several restrictions on the value. The schema processor preserves value's whitespace.
tmf854Version | TMF854_Version_T | This attribute is optional. Its form is unqualified. Show details.
Base type of tmf854Version is string. There are several restrictions on the value. The schema processor preserves value's whitespace. The value must match "`1\.([0-9]|[A-Z]|[a-z])*`".

﻿

XML
-<xsd:complexType name="getContainedInUseCTPs_T"> -<xsd:annotation> <xsd:documentation> This service is used to retrieve the "in use" CTPs that are contained within a specific PTP, FTP or CTP, at specific layer rates. An "in use" CTP is defined as a CTP that is used by an SNC in any state (including pending), either as a CM end point or as an intermediate connection point, or a CTP that is terminated and mapped. This operation will be used when there are a large number of potential CTPs (e.g., in ATM). Example of usage with respect to ATM: To retrieve all actual ATM Network Interfaces associated with a PTP, this operation will be invoked using the PTP name as the tpName and LR_ATM_NI as the only layer rate in the layerRateList. The VPI and VCI ranges that are specified in the returned ATM Network Interface transmissionParams (i.e., Max_VPI_Bits and Max_VCI_Bits) can then be used to determine the potential VPI/VCI range. A subsequent invocation of this operation using an ATM Network Interface CTP as input can be used to determine which VPIs/VCIs are actually in use (with LR_ATM_VP and LR_ATM_VC included in the connectionRateList). Example of usage with respect to SONET/SDH: Consider an STM4 PTP with layerRate: LR_Optical_OC12_and_STM4. Assume that the set of CTPs returned by operation getContainedPotentialTPs() contains one CTP with layerRate LR_STS3c_and_AU4_VC4 that is terminating an SNC (layerRate LR_STS3c_and_AU4_VC4), and another CTP with layerRate LR_STS3c_and_AU4_VC4 that is terminated and mapped (attribute tpMappingMode is set to TM_TERMINATED_AND_AVAILABLE_FOR_MAPPING). The CTP with layerRate LR_STS3c_and_AU4_VC4 that is terminated and mapped contains one CTP with layerRate LR_VT2_and_TU12_VC12 that is involved in an SNC. None of the other contained CTPs have attribute tpMappingMode set to TM_TERMINATED_AND_AVAILABLE_FOR_MAPPING, or are involved in an SNC. Operation getContainedInUseTPs then returns three CTPs: - The CTP with layerRate LR_STS3c_and_AU4_VC4 that is terminating an SNC. - The CTP with layerRate LR_STS3c_and_AU4_VC4 that has attribute tpMappingMode set to TM_TERMINATED_AND_AVAILABLE_FOR_MAPPING. - The CTP with layerRate LR_VT2_and_TU12_VC12 that is terminating an SNC. Refer to the TMF 854 XML Solution Set document for details on the Message Exchange Pattern controls (multiple batch response). Raises ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of non-specific OS internal failure EXCPT_INVALID_INPUT - Raised when tpName does not reference a PTP, FTP or CTP object or layerRateList contains undefined rates EXCPT_ENTITY_NOT_FOUND - Raised when tpName references a PTP, FTP or CTP object that does not exist EXCPT_COMM_FAILURE - Raised when communication to an entity (needed to help fulfill the request) is lost </xsd:documentation> </xsd:annotation> -<xsd:sequence> -<xsd:element name="tpName" type="NamingAttributes_T"> -<xsd:annotation> <xsd:documentation> The name of the TP for which to get contained in use TPs. The termination point name must be explicit (a generic endpoint specification may not be used in this case). See Object Naming for further detail on FTP naming. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element minOccurs="0" name="layerRateList" type="LayerRateList_T"> -<xsd:annotation> <xsd:documentation> The list of rates of the contained in use CTPs to be returned. An empty list indicates to get all contained in use CTPs (of all rates). </xsd:documentation> </xsd:annotation> </xsd:element> </xsd:sequence> <xsd:attribute name="extVersion" type="xsd:string" use="optional" /> <xsd:attribute name="extAuthor" type="xsd:string" use="optional" /> <xsd:attribute name="tmf854Version" type="TMF854_Version_T" use="optional" /> </xsd:complexType>

﻿

Uses
Type (4) LayerRateList_T NamingAttributes_T string TMF854_Version_T

Used-By
Element (1) getContainedInUseCTPs

Generated by WSDLdoc ©