tmf854.v1 > getAllSupportedPTPs_T LOCATION: file:/xsd/interfaces/EquipmentInventoryMgr.xsd
SECTIONS: Basic | XML Instance | Attributes | XML | Reference Overview | TOC | No TOC | Help
tmf854.v1
The getAllSupportedPTPs_T Complex Type
This service allows an NMS to request the PTPs/FTPs that are directly supported by a given equipment. The PTPs that are returned are those that share their physical layer with the primary equipment (i.e. that represent a port on the equipment or are connected by a fibre, wire, etc.). The FTPs that are returned are those which are implemented by the physical circuitry supported by the equipment and will include FTPs that are named from the specified equipment (the FTPs will depend upon the presence of that equipment for their most basic operation). When there is equipment protection, this operation reports PTPs/FTPs for the primary equipment only. That is, when called on a protecting equipment (as opposed to the primary equipment), this operation returns an empty list, irrespective of the current switch status. 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 equipmentName does not reference an equipment object EXCPT_ENTITY_NOT_FOUND - Raised when equipmentName references 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)
  equipmentName

Complex Type getAllSupportedPTPs_T
The getAllSupportedPTPs_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 equipment for which to retrieve supported PTPs/FTPs <equipmentName extVersion="xsd:string" extAuthor="xsd:string" tmf854Version="TMF854_Version_T">NamingAttributes_T</equipmentName> [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="getAllSupportedPTPs_T"> -<xsd:annotation> <xsd:documentation> This service allows an NMS to request the PTPs/FTPs that are directly supported by a given equipment. The PTPs that are returned are those that share their physical layer with the primary equipment (i.e. that represent a port on the equipment or are connected by a fibre, wire, etc.). The FTPs that are returned are those which are implemented by the physical circuitry supported by the equipment and will include FTPs that are named from the specified equipment (the FTPs will depend upon the presence of that equipment for their most basic operation). When there is equipment protection, this operation reports PTPs/FTPs for the primary equipment only. That is, when called on a protecting equipment (as opposed to the primary equipment), this operation returns an empty list, irrespective of the current switch status. 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 equipmentName does not reference an equipment object EXCPT_ENTITY_NOT_FOUND - Raised when equipmentName references 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="equipmentName" type="NamingAttributes_T"> -<xsd:annotation> <xsd:documentation> the name of the equipment for which to retrieve supported PTPs/FTPs </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) getAllSupportedPTPs

Generated by WSDLdoc ©