Standard properties of classes

Overview

All object classes in the schema definition files contain the following standard property elements:

actionMask—configuration operation to perform on an object
children-Set—set of contained children of an object
objectFullName—NFM-P identifier of an object instance
selfAlarmed—whether an object raises alarms

The following figure shows the standard properties definition of the fm.AdditionalTextAttribute class.

Figure 10-3: Standard properties definition for a class

<xsd:complexType name="fm.AdditionalTextAttribute">\

    <xsd:all>

            <!-- standard properties -->

            <xsd:element name="objectFullName" minOccurs="0">

                <xsd:simpleType>

                    <xsd:restriction base="xsd:string">

                        <xsd:maxLength value="252"/>

                    </xsd:restriction>

                </xsd:simpleType>

            </xsd:element>

            <xsd:element name="actionMask" type="generic.ModifierActionMask" minOccurs="0"/>

            <xsd:element name="children-Set" type="Children-Set" minOccurs="0"/>

            <xsd:element name="selfAlarmed" type="xsd:boolean" minOccurs="0"/>

actionMask element

Each class definition contains an actionMask element that specifies what operation is to be performed on the object. The actionMask element is used only for object configuration. You can use the genericTypes.xsd file to specify the actionMask element definition (generic.ModifierActionMask).

The following table lists and describes the actionMask element values.

Table 10-3: actionMask element values

Action type	Numeric ID	Description
create	1	Creates an object based on the specified parameters. Only read-write and read-create attributes are allowed. The read-create attribute is mandatory.
modify	2	Modifies an existing object based on the specified parameters. Only read-write attributes are allowed.
delete	4	Deletes an object.
reset	8	Resets the parameters of an existing object to the default values.

Note: Not all actionMask values apply to all classes.

Nokia recommends that you use one action type for each request. However, you can combine action types. For example, when you want to create and modify an object that does not exist, you can specify the create and modify actions in the same request. The following figure shows an example of a combined request

Figure 10-4: Combined create and modify request example

<actionMask>

   <bit>create</bit>

   <bit>modify</bit>

</actionMask>

children-Set element

The objects in the XML API model are organized in a hierarchy. The parent-child relationships of the hierarchy are defined by the children-Set element of an object.

The following figure is an example that shows how the children-Set element is used in an XML request to set the base card in slot 7 of an NE to In Service, and to provision the card as a card_iom2_20g.

Figure 10-5: children-Set example

<equipment.CardSlot>

   <actionMask>

      <bit>modify</bit>

   </actionMask>

   <children-Set>

      <equipment.BaseCard>

         <actionMask>

      <administrativeState>inService</administrativeState>

      <slotId>7</slotId>

         <specificType>

            <bit>card_iom2_20g</bit>

         </specificType>

      </equipment.BaseCard>

   </children-Set>

</equipment.CardSlot>

objectFullName element

The objectFullName element specifies the fully distinguished name, or FDN, that uniquely identifies an object. The objectFullName format depends on the object type. Table 10-4, Object FDN examples lists the FDN formats of various object types.

Note: There is no documented list of object full name formats. The samples in Table 10-4, Object FDN examples are not guaranteed to remain valid between NFM-P releases. Nokia recommends that XML APIrequest writers find FDNs to use in their requests by performing a find request for the class of the object they are looking for. See Inventory retrieval methods for information about the find method.

For a class that has no associated objects, a find request does not return a result from which you can obtain an FDN. In such a scenario, you must create the object using an NFM-P GUI client, and then perform the find request.

You can also monitor the NFM-P logs for the FDN of an object that you create or modify using the GUI. See Logging XML requests, responses, and exceptions in XML message structure for information about logging.

Table 10-4: Object FDN examples

Network object (class)	Format	Example
Network element
Network element	Created for each managed NE and forms the base of site-specific objects. network:siteID	network:10.1.1.88
Policies
Policy manager	A policy manager exists for each type of policy at the network and element level and contains sets of policies of a type. For example, access and slope. policy Manager Type for network level or network:siteID:policyManagerType for element level	Access Egress or network:10.1.1.88:Access Egress
Access egress policy (aengr.Policy)	policy Manager Type:ID or network:siteID:policyManagerType:policyID for element level	Access Egress:2 or network:10.1.1.88:Access Egress:2
Access egress queue (aengr.Queue)	network:siteID:policyManagerType:policyID:queue-ID	network:10.1.1.88:Access Egress:2:queue-1
Access ingress policy (aingr.Policy)	policyManagerType:ID or network:siteID:policyManagerType:policyID for element level	Access Ingress:2 or network:10.1.1.88:Access Ingress:2
Access ingress forwarding class (aingr.ForwardingClass)	policyManagerType:forwarding-class-type or network:siteID:policyManagerType:forwarding-class-type for element level	Access Engress:2:forwarding-class-be or network:10.1.202.94:Access Engress:2:forwarding-class-be
Access ingress queue (aingr.Queue)	network:siteID:policyManagerType:policyID:queue-ID	network:10.1.1.88:Access Ingress:2:queue-1
Network policy (niegr.Policy)	Network:ID or network:siteID:Network:ID for element level	Network:2 network:10.1.1.88:Network:2
Network forwarding class (niegr.ForwardingClass)	NetworkID:forwarding-class-type or network:siteID:NetworkID:forwarding-class-type for element level	network:10.1.1.88:Network:3:forwarding-class-af
File policy (file.Policy)	File:policyID or network:siteID:File:ID for element level	File:2 or network:10.1.1.88:File:2
Slope policy (slope.Policy)	slopeName or network:siteID:Slope:default	network:10.1.1.88:Slope:default
IP filter policy (aclFilter.IPFilter)	IP Filter:policyID or network:siteID:IP Fitler:policyID for element level	IP Filter:5 or network:10.1.1.88:IP Filter:5
Mediation security policy (security.MediationPolicy)	pollerManager:mediation-security-policyID	pollerManager:mediation-security-1
Deployment policy (mediation.DeploymentPolicy)	Default.DeployerBank:Policy	Default.DeployerBank:Policy
Deployment (generic.DeployerInfo)	Default.DeployerBank:depl-ID	Default.DeployerBank:depl-322
Router
Router (rtr.VirtualRouter)	There is only one VR for each NE. network:siteID:router-1 for element level	network:10.1.1.88:router-1
Network Interface (rtr.NetworkInterface)	network:siteID:router-1:ip-interface-ID for element level	network:10.1.1.88:router-1:ip-interface-2
Static route (rtr.StaticRoute)	network:siteID:router-1:SR-ID-DestinationsiteID- IP mask for element level	network:10.1.1.88:router-1:SR-2-12.119.60.0-255.255.255.0
OSPF
OSPF (ospf.area)	ospf:area-siteID	ospf:area-2.2.2.2
OSPF site (ospf.Site)	network:siteID:router-1:ospf for element level	network:10.11.1.219:router-1:ospf
OSPF area (ospf.AreaSite)	network:siteID:router-1:ospf:areaSite-siteID for element level	network:10.11.1.219:router-1:ospf:areaSite-0.0.0.0
OSPF interface (ospf.interface)	network:siteID:router-1:ospf:areaSite-siteID:interface-siteID for element level	network:10.11.1.219:router-1:ospf:areaSite-0.0.0.0:interface-3.3.3.3.0
OSPF export policy (ospf.ExportPolicy)	network:siteID:router-1:ospf:exportPolicy for element level	network:10.11.1.219:router-1:ospf:exportPolicy
BGP
BGP (bpg.Site)	network:siteID:router-1:bgp for element level	network:10.11.1.219:router-1:bgp
BGP peer group (bpg.PeerGroup)	network:siteID:router-1:bgp:group-Group name for element level	network:10.11.1.219:router-1:bgp:group-Sample-Client
BGP group import policy (bgp.GroupImportPolicy)	network:siteID:router-1:bgp:group-Group name:importPolicy for element level	network:10.11.1.219:router-1:bgp:group-Sample-Client:importPolicy
BGP group export policy (bgp.GroupExportPolicy)	network:siteID:router-1:bgp:group-Group name:exportPolicy for element level	network:10.11.1.219:router-1:bgp:group-Sample-Client:exportPolicy
BGP site export policy (bgp.SiteExportPolicy)	network:siteID:router-1:bgp:exportPolicy for element level	network:10.11.1.219:router-1:bgp:exportPolicy
BGP site import policy (bgp.SiteExportPolicy)	network:siteID:router-1:bgp:importPolicy for element level	network:10.11.1.219:router-1:bgp:importPolicy
BGP confederation (bgp.Confederation)	network:siteID:router-1:confederation-ID for element level	network:10.11.1.219:router-1:confederation-100
BGP confederation member (bgp.ConfederationMember)	network:siteID:router-1:confederation-ID:member-ID for element level	network:110.11.1.219:router-1:confederation-100:member-10
LDP
LDP (ldp.Site)	network:siteID:router-1:ldp for element level	network:10.11.1.219:router-1:ldp
MPLS
MPLS (mpls.Site)	network:siteID:router-1:mpls for element level	network:10.1.1.219:router-1:mpls
MPLS interface (mpls.interface)	network:siteID:router-1:mpls:interface-ID for element level	network:10.1.1.219:router-1:mpls:interface-1
MPLS dynamic LSP (mpls.DynamicLSP)	lsp:from-Source siteID-id-ID	lsp:from-10.1.1.88-id-1
MPLS LSP path (mpsl.LspPath)	lsp:from-Source siteID-id-ID:lsppath-ID	lsp:from-10.1.1.88-id-1:lsppath-2
MPLS provisioned path (mpls.ProvisionedPath)	provisionedMplsTePath:from-Source siteID-id-ID	provisionedMplsTePath:from-10.1.1.88-id-1
MPLS provisioned hop (mpls.ProvisionedHop)	provisionedMplsTePath:from-Source siteID-id-ID:hop-ID	provisionedMplsTePath:from-10.1.1.88-id-1:hop-2
MPLS tunnel (mpls.Tunnel)	mplsTunnel:from-Source siteID-id-ID	mplsTunnel:from-10.1.1.88-id-1
Subscribers
Subscriber (subscr.Subscriber)	subscriber:ID	subscriber:21
Services
Service (service.Service)	serviceManager:service:ID	svc-mgr:service-12
Service site (service.Site)	serviceManager:service:ID:siteID	svc-mgr:service-5:10.1.1.91
Service access interface (service.AccessInterface)	serviceManager:serviceID:site ID:ip-interface-ID	svc-mgr:service-5:10.1.1.91:interface-1/1/4-inner-tag-0-outer-tag-11 or svc-mgr:service-52:10.1.202.93:ip-interface-2051
Channels
STS192 Channel (sonetequipment.Sts192Channel)	network:siteID:shelf-ID:cardSlot-ID:card:daughterCardSlot-ID:daughterCard:port-ID:Sts192Channel	network:10.1.1.218:shelf-1:cardSlot-2:card:daughterCardSlot-1:daughterCard:port-1:sts192-1
DS3/E3 Channel (tdmequipment.DS3E3Channel)	network:siteID:shelf-ID:cardSlot-ID:card:daughterCardSlot-ID:daughterCard:port-ID:DS3E3Channel-ID	network:10.1.1.218:shelf-1:cardSlot-3:card:daughterCardSlot-1:daughterCard:port-1:ds3e3-1
DS0 Channel Group (tdmequipment.DS0ChannelGroup)	network:siteID:shelf-ID:cardSlot-ID:card:daughterCardSlot-ID:daughterCard:port-ID:DS1E1Channel-ID:DS0ChannelGroup-ID	network:10.1.1.218:shelf-1:cardSlot-3:card:daughterCardSlot-1:daughterCard:port-1:ds1e1-3:ds0Grp-3

Non-standard parameter elements

A class definition may include one or more parameter elements in addition to the standard elements. Each element definition has a header that contains some or all of the following:

Name—parameter name
Defined in—parent class
Min/Max—minimum and maximum values
Default—default value
Access—allowed access type

The following figure shows the EncapValue parameter definition in the antispoof.AntiSpoofingFilter class.

Figure 10-6: Parameter element definition example

<!--

  -   Name:       EncapValue

  -   Defined in: antispoof.AntiSpoofingFilter

  -   Default:    0

  -   Access:     Read-Write
  -->

<xsd:element name="encapVal" minOccurs="0">

   <xsd:simpleType>

      <xsd:restriction base="xsd:long">

         <xsd:minInclusive value="0"/>

         <xsd:maxInclusive value="4294967295"/>

      </xsd:restriction>

   </xsd:simpleType>

</xsd:element>

Accessibility types

Each parameter element has one of the following accessibility types:

read-only—the element is read-only and cannot be used in a configuration request
read-write—the element can be modified using a create or modify request
read-create—the element can be modified using only a create request