tmf854.v1 > getContainedPotentialCTPs_T LOCATION: file:/xsd/interfaces/ManagedElementMgr.xsd
SECTIONS: Basic | XML Instance | Attributes | XML | Reference Overview | TOC | No TOC | Help
tmf854.v1
The getContainedPotentialCTPs_T Complex Type
This allows an NMS to request all of the CTPs that it is potentially capable of supporting in all possible mapping configurations, at the specified rates and that are contained by the specified termination point. This service returns all potential contained CTPs for a given TP. The TP may be a PTP, an FTP or a CTP. If the layerRateList is empty then contained CTPs at all flexible and/or static LayerRates are returned. For an OC3 PTP that has the potential of mapping to VT1.5 the response would contain 3 STS1 CTPs and 84 VT1.5 CTPs; on a T1 PTP, the contained TPs would be one T1 CTP; for an STS1 CTP the response would contain 28 VT1.5 CTPs. In the case where an OC3 PTP supports mapping to T1s and VT1.5, then the contained list for the OC3 PTP could be 1 STS3c, 3 STS1, 84 VT1.5 and 84 T1 CTPs; if a VT1.5 CTP is provided, 1 T1 CTP is returned; if a T1 CTP is provided, the result is an empty list. Whenever a protection group is involved, the behaviour of this service is described below: Scenario 1: Before the Protection Group is created - Query On Worker TPs returns list of all CTPs - Query On Protection TPs returns list of all CTPs Scenario 2: After ProtectionGroup is created, if extra (preemptible/non-pre-emptible) traffic is allowed. - Query On Worker TPs returns list of all CTPs - Query On Protection TPs returns list of all CTPs Scenario 3: After ProtectionGroup is created, if extra (preemptible/non-pre-emptible) traffic is not allowed - Query On Worker TPs returns list of CTPs that allow protected traffic - Query On Protection TPs returns an empty list (regardless of the switch status) In case the protection group is created after a query is made, no object delete notification is made, the NMS is expected to query the ports in the protection group to find the list of contained CTPs. When ATM, this operation needs to be used with caution. The reason for this is that, in ATM, there can be a prohibitively large number of potential VP and VC CTPs returned by this operation. For retrieving ATM CTPs, the getContainedInUseTPs() operation should be considered. If DWDM, SONET and/or SDH is combined with ATM, it is advisable that this operation be used with the appropriate DWDM, SONET and/or SDH layer rates entered into the layerRateList. Otherwise, ATM CTPs will be returned and the resulting list of contained TPs could get prohibitive Refer to the TMF 854 XML Solution Set document for details on the Message Exchange Pattern controls (multiple batch response). Raises ProcessingFailureException EXCPT_NOT_IMPLEMENTED - Raised if OS cannot support this service 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 getContainedPotentialCTPs_T
The getContainedPotentialCTPs_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 PTP, FTP or CTP for which to get contained CTPs. 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="getContainedPotentialCTPs_T"> -<xsd:annotation> <xsd:documentation> This allows an NMS to request all of the CTPs that it is potentially capable of supporting in all possible mapping configurations, at the specified rates and that are contained by the specified termination point. This service returns all potential contained CTPs for a given TP. The TP may be a PTP, an FTP or a CTP. If the layerRateList is empty then contained CTPs at all flexible and/or static LayerRates are returned. For an OC3 PTP that has the potential of mapping to VT1.5 the response would contain 3 STS1 CTPs and 84 VT1.5 CTPs; on a T1 PTP, the contained TPs would be one T1 CTP; for an STS1 CTP the response would contain 28 VT1.5 CTPs. In the case where an OC3 PTP supports mapping to T1s and VT1.5, then the contained list for the OC3 PTP could be 1 STS3c, 3 STS1, 84 VT1.5 and 84 T1 CTPs; if a VT1.5 CTP is provided, 1 T1 CTP is returned; if a T1 CTP is provided, the result is an empty list. Whenever a protection group is involved, the behaviour of this service is described below: Scenario 1: Before the Protection Group is created - Query On Worker TPs returns list of all CTPs - Query On Protection TPs returns list of all CTPs Scenario 2: After ProtectionGroup is created, if extra (preemptible/non-pre-emptible) traffic is allowed. - Query On Worker TPs returns list of all CTPs - Query On Protection TPs returns list of all CTPs Scenario 3: After ProtectionGroup is created, if extra (preemptible/non-pre-emptible) traffic is not allowed - Query On Worker TPs returns list of CTPs that allow protected traffic - Query On Protection TPs returns an empty list (regardless of the switch status) In case the protection group is created after a query is made, no object delete notification is made, the NMS is expected to query the ports in the protection group to find the list of contained CTPs. When ATM, this operation needs to be used with caution. The reason for this is that, in ATM, there can be a prohibitively large number of potential VP and VC CTPs returned by this operation. For retrieving ATM CTPs, the getContainedInUseTPs() operation should be considered. If DWDM, SONET and/or SDH is combined with ATM, it is advisable that this operation be used with the appropriate DWDM, SONET and/or SDH layer rates entered into the layerRateList. Otherwise, ATM CTPs will be returned and the resulting list of contained TPs could get prohibitive Refer to the TMF 854 XML Solution Set document for details on the Message Exchange Pattern controls (multiple batch response). Raises ProcessingFailureException EXCPT_NOT_IMPLEMENTED - Raised if OS cannot support this service 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 PTP, FTP or CTP for which to get contained CTPs. 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) getContainedPotentialCTPs

Generated by WSDLdoc ©