tmf854.v1 > getRoute_T LOCATION: file:/xsd/interfaces/MultiLayerSubnetworkMgr.xsd
SECTIONS: Basic | XML Instance | Attributes | XML | Reference Overview | TOC | No TOC | Help
tmf854.v1
The getRoute_T Complex Type
This service returns the route for the SNC whose name is specified as a parameter. This operation also works for bundled SNCs. The route information, in the form of crossconnects, should identify the resources allocated to the SNC at the time of the request and the way in which these resources are used. For example, for a resilient SNC that is implemented in the subnetwork using subnetwork connection protection, all details of the route including normal and alternative paths should be provided. If the SNC is using some form of dynamic rerouting then it is clearly acceptable that the route include only the single thread of crossconnections that is supporting the traffic (as there may be many alternative potential paths that could be selected). The NMS specifies if it wants to retrieve only resources in the layer of the SNC (the CCs that belong to the SNC), or higher order CCs also (the CCs of other SNCs that are used to carry the traffic of the queried SNC). The ability to retrieve higher order CCs is optional. All cross-connections allocated to the SNC must be returned, even if they are not active in the managed elements. This allows the NMS to query the route that will be used before activating an SNC. If the SNC has more alternative routes, then it retrieves the intended route if the SNC is pending or partial, otherwise it retrieves the active route. This because there can be more partial routes and no active route, in such case the intended route is replied, as it is not known which of the partial routes is the candidate for becoming the active route. In the vendorExtension field of first CrossConnect_T (first XC is the one involving A1 end point of the SNC) record of the replied sequence the following parameters may be present: name="RouteId"; value="id" name="RouteIntended "; value="y" | "n" name="RouteActualState"; value="inactive" | "partial" | "active" name="RouteAdminState"; value="locked" | "unlocked" name="RouteInUse"; value="y" | "n" name="RouteExclusive"; value="y" | "n" Raises ProcessingFailureException EXCPT_NOT_IMPLEMENTED - Raised if the OS does not support this service EXCPT_INTERNAL_ERROR - Raised in case of non-specific OS internal failure EXCPT_INVALID_INPUT - Raised when sncName does not reference a subnetworkConnection object EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an SNC object that does not exist EXCPT_UNABLE_TO_COMPLY - Raised when the provided value for includeHigherOrderCCs is "True" and OS is not able to provide higher order CCs in the reply

Local elements (2)
  sncName includeHigherOrderCCs

Complex Type getRoute_T
The getRoute_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 SNC. <sncName extVersion="xsd:string" extAuthor="xsd:string" tmf854Version="TMF854_Version_T">NamingAttributes_T</sncName> [1..1] Specifies whether the higher order CCs of other SNCs used to carry the queried SNC have to be included in addition to the CCs of the queried SNC <includeHigherOrderCCs>xsd:boolean</includeHigherOrderCCs> [1..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
--- | --- | ---
No Attributes

﻿

XML
-<xsd:complexType name="getRoute_T"> -<xsd:annotation> <xsd:documentation> This service returns the route for the SNC whose name is specified as a parameter. This operation also works for bundled SNCs. The route information, in the form of crossconnects, should identify the resources allocated to the SNC at the time of the request and the way in which these resources are used. For example, for a resilient SNC that is implemented in the subnetwork using subnetwork connection protection, all details of the route including normal and alternative paths should be provided. If the SNC is using some form of dynamic rerouting then it is clearly acceptable that the route include only the single thread of crossconnections that is supporting the traffic (as there may be many alternative potential paths that could be selected). The NMS specifies if it wants to retrieve only resources in the layer of the SNC (the CCs that belong to the SNC), or higher order CCs also (the CCs of other SNCs that are used to carry the traffic of the queried SNC). The ability to retrieve higher order CCs is optional. All cross-connections allocated to the SNC must be returned, even if they are not active in the managed elements. This allows the NMS to query the route that will be used before activating an SNC. If the SNC has more alternative routes, then it retrieves the intended route if the SNC is pending or partial, otherwise it retrieves the active route. This because there can be more partial routes and no active route, in such case the intended route is replied, as it is not known which of the partial routes is the candidate for becoming the active route. In the vendorExtension field of first CrossConnect_T (first XC is the one involving A1 end point of the SNC) record of the replied sequence the following parameters may be present: name="RouteId"; value="id" name="RouteIntended "; value="y" | "n" name="RouteActualState"; value="inactive" | "partial" | "active" name="RouteAdminState"; value="locked" | "unlocked" name="RouteInUse"; value="y" | "n" name="RouteExclusive"; value="y" | "n" Raises ProcessingFailureException EXCPT_NOT_IMPLEMENTED - Raised if the OS does not support this service EXCPT_INTERNAL_ERROR - Raised in case of non-specific OS internal failure EXCPT_INVALID_INPUT - Raised when sncName does not reference a subnetworkConnection object EXCPT_ENTITY_NOT_FOUND - Raised when sncName references an SNC object that does not exist EXCPT_UNABLE_TO_COMPLY - Raised when the provided value for includeHigherOrderCCs is "True" and OS is not able to provide higher order CCs in the reply </xsd:documentation> </xsd:annotation> -<xsd:sequence> -<xsd:element name="sncName" type="NamingAttributes_T"> -<xsd:annotation> <xsd:documentation> The name of the SNC. </xsd:documentation> </xsd:annotation> </xsd:element> -<xsd:element name="includeHigherOrderCCs" type="xsd:boolean"> -<xsd:annotation> <xsd:documentation> Specifies whether the higher order CCs of other SNCs used to carry the queried SNC have to be included in addition to the CCs of the queried SNC </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) boolean NamingAttributes_T string TMF854_Version_T

Used-By
Element (1) getRoute

Generated by WSDLdoc ©