tmf854.v1 > getInventory_T > filter
LOCATION: file:/xsd/interfaces/InventoryRetrieval.xsd
SECTIONS: Basic | XML Instance | Attributes | XML | Reference Overview | TOC | No TOC | Help
tmf854.v1
The filter Element
defines the subset of the total inventory to be returned to the requesting OS.
Element getInventory_T/filter : SimpleFilter_T [0 .. 1]
The filter element cannot have "xsi:nil" as an attribute. The filter element in XML instance can be substituted with other elements.

XML Instance
defines the subset of the total inventory to be returned to the requesting OS. <filter extVersion="xsd:string" extAuthor="xsd:string" tmf854Version="TMF854_Version_T"> -Begin Sequence [1...1] This attribute identifies a list of base object instances for the subtrees to be retrieved. BaseInstanceList is a list of serialized MTOSI names. If the BaseInstanceList is left empty then all the nodes at the top of the MTOSI instance tree are selected (i.e., all MDs, TMDs, and OSs are selected). Specification of the BaseInstanceList does not select any objects in and of itself. In order to select specific objects, one needs to specify the IncludedObjectTypes. <baseInstance extVersion="xsd:string" extAuthor="xsd:string" tmf854Version="TMF854_Version_T">NamingAttributes_T</baseInstance> [0..*] This attribute identifies the type of objects contained under the selected base object instances that are to be included in the returned inventory file. The base object itself is included only if the type of the base instance appears in the IncludedObjectTypes list. If no included object types are listed, then the entire subtree under the base object instance is returned. For each included object type, one needs to indicate whether. just the name, all the associated attributes (including the name), or the associated attributes and relationship pointers are to be returned for each instance. The IncludedObjectTypes need to be picked such that each selected base class has a single (connected) subtree below it. For example, if all the EHs under a given MD where needed, the requesting OS would need to list the given MD as a base instance and put ME and EH in the IncludedObjectTypes list. The requesting OS could just request the names of the MEs to reduce the size of the returned file. <includedObjectType> -Begin Sequence [1...1] Specify the object type acronym. The ";" is used as a separator, and "=" is used to associate a value with a type of object. For example, MD=md1;ME=ME123;EH=ACME7 identifies an equipment holder within managed element ME123 within management domain md1. The relative name of the equipment holder is ACME7. <objectType>ObjectAcronym_T</objectType> [1..1] Specify the granularity of the inventory report. <granularity>Granularity_T</granularity> [1..1] End Sequence </includedObjectType> [0..*] End Sequence </filter>

﻿

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
﻿
Name | Type | Summary
--- | --- | ---
No Attributes
﻿
Name | Type | Summary
--- | --- | ---
No Attributes

﻿

XML
-<xsd:element minOccurs="0" name="filter" type="SimpleFilter_T"> -<xsd:annotation> <xsd:documentation> defines the subset of the total inventory to be returned to the requesting OS. </xsd:documentation> </xsd:annotation> </xsd:element>

﻿

Uses
Type (1) SimpleFilter_T

Used-By

Generated by WSDLdoc ©