tmf854.v1 > getAllSupportingEquipment_T LOCATION: file:/xsd/interfaces/EquipmentInventoryMgr.xsd
SECTIONS: Basic | XML Instance | Attributes | XML | Reference Overview | TOC | No TOC | Help
tmf854.v1
The getAllSupportingEquipment_T Complex Type
This service allows an NMS to request all of the equipment which implement a PTP/FTP. For a PTP, the equipments that are returned are those which support the physical layer of the PTP (i.e. have the port on them or are connected by a fibre, wire, etc.). For an FTP, the equipments returned are those which support the physical circuitry implementing the FTP and will include the equipment from which the FTP is named (the FTPs will depend upon the presence of that equipment for their most basic operation). For a particular PTP/FTP the Tx port/function and Rx port/function may be on different cards and in this case both should be returned. Equipment that are used by the PTPs/FTPs, but that do not support them directly (such as a shared DEMUX card) are not reported. When there is equipment protection, this operation reports the primary equipment only. The protecting equipment will not be returned by this operation Raises ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of non-specific OS internal failure EXCPT_INVALID_INPUT - Raised when ptpName does not reference a PTP/FTP object EXCPT_ENTITY_NOT_FOUND - Raised when ptpName references a PTP/FTP object that does not exist EXCPT_COMM_FAILURE - Raised when communication to an entity (needed to help fulfill the request) is lost

Local elements (1)
  ptpName

Complex Type getAllSupportingEquipment_T
The getAllSupportingEquipment_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"> the name of the PTP/FTP for which to retrieve the supporting equipments. 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 <ptpName extVersion="xsd:string" extAuthor="xsd:string" tmf854Version="TMF854_Version_T">NamingAttributes_T</ptpName> [1..1] </...>

﻿

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])*`".

﻿

XML
-<xsd:complexType name="getAllSupportingEquipment_T"> -<xsd:annotation> <xsd:documentation> This service allows an NMS to request all of the equipment which implement a PTP/FTP. For a PTP, the equipments that are returned are those which support the physical layer of the PTP (i.e. have the port on them or are connected by a fibre, wire, etc.). For an FTP, the equipments returned are those which support the physical circuitry implementing the FTP and will include the equipment from which the FTP is named (the FTPs will depend upon the presence of that equipment for their most basic operation). For a particular PTP/FTP the Tx port/function and Rx port/function may be on different cards and in this case both should be returned. Equipment that are used by the PTPs/FTPs, but that do not support them directly (such as a shared DEMUX card) are not reported. When there is equipment protection, this operation reports the primary equipment only. The protecting equipment will not be returned by this operation Raises ProcessingFailureException EXCPT_INTERNAL_ERROR - Raised in case of non-specific OS internal failure EXCPT_INVALID_INPUT - Raised when ptpName does not reference a PTP/FTP object EXCPT_ENTITY_NOT_FOUND - Raised when ptpName references a PTP/FTP 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="ptpName" type="NamingAttributes_T"> -<xsd:annotation> <xsd:documentation> the name of the PTP/FTP for which to retrieve the supporting equipments. 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: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 (3) NamingAttributes_T string TMF854_Version_T

Used-By
Element (1) getAllSupportingEquipment

Generated by WSDLdoc ©