Explains how to use resmgr to manage design objects
This section explains how to use resmgr to export, import, and different Tivoli Netcool Performance Manager object types that belong to the Design category.
Design objects include the following types:
v Formulas v Properties v Thresholds v Requests v Calendars v Timezones v Inventory profiles
Before using the commands in this chapter, review the information inom Chapter 4,
“Managing Tivoli Netcool Performance Manager objects,” on page 15.
Working with formulas
This section contains the commands you can use to manage formulas. You should use the Tivoli Netcool Performance Manager DataMart Formula Editor to create formulas. When you use resgmr to work with the elements, you work with the following object types:
v frm v fgp
v linkGroupF (import only)
You need to use the -sepRec option because the formula data are not stored on a single row. You need to define another separator other than the carriage return. By default the -sepRec option used for formula is <E>.
Exporting formulas
The following examples of resmgr command used to export formulas contain the command and the results of that command.
Exporting formula groups
resmgr -export fgp -colNames "dbIndex nName frm.dbIndex frm.data frm.type frm.comment frm.date frm.state" -sepRec "<E>" -file
$DIR/fgp.dat
# type = fgp
# col = dbIndex nName frm.dbIndex frm.data frm.type frm.comment frm.date frm.state
# filter =
# order =
# sep = |_|
# sepRec = <E>
# rule =
# filterRule =
#
# cmdLine = -export fgp -colNames "dbIndex nName frm.dbIndex frm.data frm.type frm.comment frm.date frm.state"
1932|_|~Alias Instance and Label
Inventory~AP~Cisco_IPSec|_|4114|_|V1=OIDVAL(sysLocation.0,once);
V2=OIDVAL(sysName.0);
V3=OIDVAL(%H1);
%V1 index "IPSec<NULL>||IPSec agent on: %V3
(%V2)||location<%V1>||";|_|snmp|_|SNMP Discovery Formula for the "Cisco_IPSec" Family - Cisc
o router-level IPSec agents|_|999640340|_|on|_|<E>
1932|_|~Alias Instance and Label
Inventory~AP~Cisco_IPSec_match|_|4184|_|cipSecMibLevel.0|_|snmp|_|"Match"
Formula for matching SubElements to the "Cisco_IPSec" Family, since they will also fulfill requirements for Family
"1213_Device"|_|983650594|_|on|_|<E>
4353|_|~AP~Tivoli Netcool Performance Manager~DataManager~Element Average Response Time (ms)|_|4352|_|Stat( "Targets" , %H1 , "SNMP Response Time (ms) [last hour]"
)|_|snmp|_|Uses internal Tivoli Netcool Performance Manager Statistics to calculate an Elements SNMP Response
Time.|_|983650594|_|on|_|<E>
4353|_|~AP~Tivoli Netcool Performance Manager~DataManager~Element Availability (percent)|_|4354|_|Stat( "Targets" , %H1 , "SNMP Availability (%) [last hour]" )|_|snmp|_|Uses internal Tivoli Netcool Performance Manager Statistics to calculate Elements Availability in percent|_|983650594|_|on|_|<E>
4353|_|~AP~Tivoli Netcool Performance
Manager~DataManager~detect_reboot|_|4355|_|distrib(delta(sysUpTime.0),
"default:1");|_|snmp|_|An example of how to detect system reboot.|_|983650594|_|on|_|<E>
Exporting formula MIBs
resmgr -export fgp -colNames "nName frm.mibPath" -file
$DIR/fgp_mibs.dat
# type = fgp
# col = nName frm.mibPath
# filter =
# order =
# sep = |_|
# sepRec =
#
# cmdLine = -export fgp -colNames "nName frm.mibPath"
~Demo~Addressess Free|_|rfc1213-MIB-II|_|
~Demo~Address Pool Utilization (percent)|_|rfc1213-MIB-II|_|
~Alias Instance and Label
Inventory~AP~Disman_Ping_Test|_|rfc2925p.mi2|_|
~Alias Instance and Label
Inventory~AP~Cisco_CBQoS_Action|_|CISCO-CLASS-BASED-QOS-MIB.my|_|
~Alias Instance and Label
Inventory~AP~Cisco_CBQoS_Class|_|rfc1213-MIB-II|_|
~Alias Instance and Label
Inventory~AP~Cisco_CBQoS_Class|_|CISCO-CLASS-BASED-QOS-MIB.my|_|
~Alias Instance and Label
Inventory~AP~Cisco_Router_Device_SAA_Resp|_|rfc1213-MIB-II|_|
~Alias Instance and Label
Inventory~AP~Cisco_Router_Device_SAA_Resp|_|CISCO-RTTMON-MIB.my|_|
~Alias Instance and Label
Inventory~AP~Cisco_Router_Device_SAA_Resp_match|_|rfc1213-MIB-II|_|
~Alias Instance and Label
Inventory~AP~Cisco_Router_Device_SAA_Resp_match|_|cisco-10-mib|_|
~Alias Instance and Label
Inventory~AP~Cisco_Router_Device_SAA_Resp_match|_|CISCO-RTTMON-MIB.my|_|
~Alias Instance and Label
Inventory~AP~Cisco_Router_Device_SAA_match|_|rfc1213-MIB-II|_|
~Alias Instance and Label
Inventory~AP~Cisco_Router_Device_SAA_match|_|OLD-CISCO-SYSTEM-MIB.my|_|
~Alias Instance and Label
Inventory~AP~Cisco_Router_Device_SAA_match|_|CISCO-RTTMON-MIB.my|_|
~Alias Instance and Label
Inventory~AP~Cisco_Router_Device_SAA|_|rfc1213-MIB-II|_|
Importing formulas
You must use the following columns for a new formula. By default, dbIndex is taken from the designSequences column, type is import, dataType is float, nbHost is 1.
v frm v fgp
v linkGroupF
You can also include the following columns:
v for fgp, use npath
v for frm, use name data type v for type ifType, use name type
When updating formulas, you must use the following columns:
v for fgp, use dbIndex or npath (or nNam) and the columns to be modified v for frm, use dbIndex and the columns to be modified
Input file
The input file includes the following:
~Alias Instance and Label Inventory~AP~NEW Cisco_IPSec|_|V1=OIDVAL(sysLocation.0,once);
V2=OIDVAL(sysName.0);
V3=OIDVAL(%H1);
%V1 index "IPSec<NULL>||IPSec agent on: %V3
(%V2)||location<%V1>||";|_|snmp|_|SNMP Discovery Formula for the "Cisco_IPSec" Family - Cisco router-level IPSec
agents|_|<E>
Importing formula groups
resmgr -import fgp -colNames "nName frm.data frm.type frm.comment"
-file test1 -sepRec "<E>"
Info: === insert: nothing ON Formula Group (~Alias Instance and Label Inventorially ) (exists)
Info : === insert : INSERT ON Formulas ( NEW Cisco_IPSec ) (does not exist)
Info : === insert : INSERT ON Link F/G ( NEW Cisco_IPSec ~Alias Instance and Label Inventory~AP ) (does not exist)
Info : === Update Histo : 0
Deleting formulas
You must use the following columns when deleting formulas:
v for fgp, use dbIndex or npath (or nName for a formula) v for frm, use dbIndex
Deleting a formula group
resmgr -delete fgp -colNames "npath" -line "~test1"
Info : === DELETE GROUP : ~test1 (index = 100001032)
Info : === delete : DELETE ON Formula Group ( ~test1 ) (exists) Info : === Update Histo : 0
Deleting a formula
resmgr -delete frm -colNames "dbIndex" -line "100008516"
Info : === delete : DELETE ON Formulas ( NEW Cisco_IPSec ) (exists)
Unlinking a formula (for example, for a cut and paste)
resmgr -delete linkGroupF -colNames "npath frm.name" -line
"~test1|_|Cisco_MPLS_LSP"
Info : === delete : DELETE ON Link F/G ( Cisco_MPLS_LSP ~test1 ) (exists)
Info : === Update Histo : 0
Working with properties
This section contains commands you can use when you manage properties. When you work with property object types, you work with
v propertyE for the element properties v propertySE for the subelement properties v propertyRU for the report user properties Both the name and the invariant must be unique.
Three properties used by default for the element invariant include the following:
v ipName v sysName v physAddress
Subelement properties
The following table lists the subelement properties supplied by a Tivoli Netcool Performance Manager installation:
Subelement Property Description
name A specific, textual name for this entity
defined by the user, most often during general network configuration.
hostIP Physical IP address of the host upon which
this resource resides
hostURL URL address assigned to the host upon
which this resource resides
hostName Textual name assigned to the host upon which this resource resides. Defined by the user most often during general network configuration
parent Open-format name or ID assigned to an
entity considered as a "parent" containing this resource. Is usually different from a physical host (see 'hostName' property.) hostType Open-format "type" classification of the
device upon which this resource resides.
Subelement Property Description
parentType Open-format "type" classification of the parent of this resource
description Open-format description text used in
instances when helpful for grouping (currently not displayed in the DataView portal).
class Open-format name of the general class of
resource represented (for example, device, interface, logical port, end-to-end
connection, and so on.)
type Open-format name of the specific type of
resource represented (Ethernet, DS1, and so on.)
subType Additional specific type information for the
resource (NNI, UNI, and so on.)
protocol Transmission protocol specific to the
resource (ATM, Frame Relay, IP, IPSec, TCP, UDP, MPLS, and so on.)
protocolVersion Version of transmission protocol being used
model Open-format model name of the resource
modelID Open-format model ID string of the resource
version Open-format version identification of the
resource
patchLevel Open-format patch level identification of the
resource
country The country in which the resource resides
city The city, town, or municipality in which the
resource resides
state The state in which the resource physically
resides
province The province in which the resource resides
region Open-format region name at which the
resource resides
regionID Open-format ID string assigned to the
region in which the resource resides
location Physical location of the resource
locationID Open-format ID string assigned to the
physical location at which the resource resides
Subelement Property Description
status Operational status of the resource ('active',
'initializing', 'maintenance', etc.)
priority Open-format priority name or code
physicalCapacity The maximum speed of this resource (bps) committedCapacity The steady-rate bandwidth (bps) committed
for transfer over this resource.
committedBurstCapacity The transmission rate (bps) committed for short traffic bursts (for a pre-agreed duration) over this resource.
committedPeakCapacity The maximum transmission rate (bps) committed for transfer over this resource.
owner Service provider employee name/ID to
which this resource belongs
ownerCustomTag User-definable property for custom resource organization attributes
department Service provider department to which this
resource belongs
departmentID ID of the service provider department to
which this resource belongs
networkArea Network area (for example, BackBone, CPE)
of the entity
network The name of the network of which this
entity is a part.
networkID The ID of the network of which this entity is
a part.
privateNetwork The name of the private (virtual) network of which this entity is a part.
privateNetworkID The ID of the private (virtual) network of which this entity is a part.
customer The name of the specific customer that this
resource services.
customerID The ID of the specific customer that this
resource services.
customerType The type of the customer that this resource services.
Subelement Property Description
customerFacingName Alternate name to be used for this resource in customer-facing reports, messages, and so on.
securityProfileMask Open-format string for definition of a text mask which can be generated for users by a custom user group control system and used within rule conditions to organize user groups' access to resource views.
Exporting properties
The following examples of resmgr command used to export properties contain the command and the results of that command.
Exporting element properties
resmgr -export propertyE -colNames "name invariant defValue state"
-file $DIR/propertyE.dat
# type = propertyE
# col = name invariant defValue state
# filter = invariant(type<E>) invariant(type<E>)
# order =
# sep = |_|
# sepRec =
#
# cmdLine = -export propertyE -colNames "name invariant defValue state" -filter "invariant(type<E>) invariant(type<E>)"
ipAddress|_|type<E>|_||_|on|_|
ipAddressMin|_|type<E>|_||_|on|_|
ipName|_|type<E>|_||_|on|_|
physAddress|_|type<E>|_||_|on|_|
sysDescr|_|type<E>|_||_|on|_|
sysName|_|type<E>|_||_|on|_|
Exporting subelement properties
resmgr -export propertySE -colNames "name invariant defValue state"
-file $DIR/propertySE.dat
# type = propertySE
# col = name invariant defValue state
# filter = invariant(type<SE>) invariant(type<SE>)
# order =
# sep = |_|
# sepRec =
#
# cmdLine = -export propertySE -colNames "name invariant defValue state" -filter "invariant(type<SE>)
invariant(type<SE>)"
customStringProperty01|_|type<SE>|_||_|on|_|
customStringProperty02|_|type<SE>|_||_|on|_|
customStringProperty03|_|type<SE>|_||_|on|_|
customStringProperty04|_|type<SE>|_||_|on|_|
customStringProperty05|_|type<SE>|_||_|on|_|
customNumericProperty01|_|type<SE>|_||_|on|_|
customNumericProperty02|_|type<SE>|_||_|on|_|
customNumericProperty03|_|type<SE>|_||_|on|_|
customNumericProperty04|_|type<SE>|_||_|on|_|
customNumericProperty05|_|type<SE>|_||_|on|_|
testActivationInterval|_|type<SE>|_||_|on|_|
testPacketInterval|_|type<SE>|_||_|on|_|
name|_|type<SE>|_|Undefined ’name’ Property|_|on|_|
hostIP|_|type<SE>|_|Undefined ’hostIP’ Property|_|on|_|
hostURL|_|type<SE>|_||_|on|_|
Exporting property default values
You can export the default value (DefVal) of the property (as defined in the database) for a resource that does not yet exist by using the following option.
-isDefault
You can use this option with the following object types:
v eprp v seprp v ruprp
Exporting element property default values
resmgr -export elt -colNames "name eprp.Contact:value" -isDefault eprp -file $DIR/isdefault_eprp.dat
# type = elt
# col = name eprp.Contact:value
# filter =
# order =
# sep = |_|
# sepRec =
#
# cmdLine = -export elt -colNames "name eprp.Contact:value"
172.31.0.51|_|1|_|pvdemo1|_|
172.31.0.41|_|1|_|pvdemo2|_|
172.31.0.31|_|1|_|pvdemo3|_|
Delete_200000793_192.168.3.227|_|1|_|pvdemo3|_|
192.168.127.8|_|1|_|pvdemo2|_|
Displaying the defVal for properties that do not yet exist
resmgr -export propertyE -colNames "name dataType subType invariant state defValue" -file $DIR/defVal.dat
# type = propertyE
# col = name dataType subType invariant state defValue
# filter = invariant(type<E>) invariant(type<E>)
# order =
# sep = |_|
# sepRec =
#
# cmdLine = -export propertyE -colNames "name dataType subType invariant state defValue" -filter "invariant(type<E>)"
"
ipAddress|_|string|_||_|type<E>|_|on|_||_|
ipAddressMin|_|string|_||_|type<E>|_|on|_||_|
ipName|_|string|_||_|type<E>|_|on|_||_|
physAddress|_|string|_||_|type<E>|_|on|_||_|
sysDescr|_|string|_||_|type<E>|_|on|_||_|
sysName|_|string|_||_|type<E>|_|on|_||_|
Conctact|_|string|_||_|type<E>|_|on|_|pvdemo3|_|
Trouble Ticket pack properties
The following properties are a subset of Tivoli Netcool Performance Manager Technology Pack properties. See the Tivoli Netcool Performance Manager Technology Pack documentation for information.
v ServiceContract v ServiceCity v ServiceEmail v ServiceFax v ServiceFirstName v ServiceFirmName v ServiceMaxOutage v ServicePhone v ServiceRate v ServiceStatus v ServiceStreet v ServiceType v ServiceZip v ServiceLevel v SupportLevel v StatusCode v ServiceMobile v ServiceLastName v TicketID
v NetFlow Pack Property v NF_aggVIEW
v NF_type v NF_src v NF_dst v NF_cos v NF_customer
Properties used by the Tivoli Netcool Performance Manager-enabled SAA probes
The following table lists the probe properties:
Probe Property Description
operation Test operation being executed for monitor
probes, RMON, and so on.
timeout Timeout duration (seconds) for target
response for monitor probes, RMON, and so on.
sourceIP IP address of the originating side for
unidirectional entities (end-to-end simplex connections, network test probes, and so on.)
sourceURL URL of the originating side for
unidirectional entities (end-to-end simplex connections, network test probes, etc.)
Probe Property Description
sourcePort IP port used on the originating side for
unidirectional entities (end-to-end simplex connections, network test probes, and so on.)
destIP IP address of the terminating side for
unidirectional entities (end-to-end simplex connections, network test probes, and so on.)
destURL URL of the terminating side for
unidirectional entities (end-to-end simplex connections, network test probes, and so on.)
destPort IP port used on the terminating side for
unidirectional entities (End-to-end simplex connections, network test probes, and so on.) ProbeDefaultIPAddress IP address of probe
responderEnabled For latency probes, this identifies whether or not a target will respond to the probe.
testActivationInterval Time between activations of a latency test. A latency test does not run continuously. It is dormant for a period of time, activates, and sends one or more test packets/probes/
requests.
testPacketInterval Interval between packets /probes/requests for a latency test that sends multiple packets/probes/requests per test activation.
Exporting report user properties
resmgr -export propertyRU -colNames "name invariant defValue state"
-file $DIR/propertyRU.dat
# type = propertyRU
# col = name invariant defValue state
# filter = invariant(type<DVUser>)
# order =
# sep = |_|
# sepRec =
#
# cmdLine = -export propertyRU -colNames "name invariant defValue state" -filter "invariant(type<DVUser>)"
DV_UserAccessScheduler|_|type<DVUser>|_||_|on|_|
DV_UserCSSFilename|_|type<DVUser>|_||_|on|_|
DV_UserCustomLogoFile|_|type<DVUser>|_||_|on|_|
DV_UserEnableFavoriteLink|_|type<DVUser>|_||_|on|_|
DV_UserFavoriteURL|_|type<DVUser>|_||_|on|_|
DV_UserGranularitySetting |_|type<DVUser>|_||_|on|_|
DV_UserGranularity_14MONTHS|_|type<DVUser>|_||_|on|_|
DV_UserGranularity_DAILY|_|type<DVUser>|_||_|on|_|
DV_UserGranularity_MONTHLY|_|type<DVUser>|_||_|on|_|
DV_UserGranularity_QUARTERLY|_|type<DVUser>|_||_|on|_|
DV_UserGranularity_WEEKLY|_|type<DVUser>|_||_|on|_|
DV_UserGranularity_YEARLY|_|type<DVUser>|_||_|on|_|
DV_UserLoginName|_|type<DVUser>|_||_|on|_|
DV_UserName|_|type<DVUser>|_||_|on|_|
DV_UserPreferenceAccess|_|type<DVUser>|_||_|on|_|
# for propertyRU :
# DV_UserProfile : ("NOC","PSLA","SLA")
# DV_UserCustomLogoFile :
# DV_UserResourceName
The following table list report user properties:
Report User Property Description DV_UserProfile
DataView user-scope property defining the general user type for control of certain security options.
Valid settings:
v NOC - Network Operations Center user, few restrictions.
v PSLA - Proactive Service Level Agreement personnel, moderate restriction.
v SLA - End users, highest restriction.
DV_UserCustomLogoFile DataView user-scope property with a link to an image file statically defining a custom graphic for reporter summary headings.
DV_UserResourceName
DataView user-scope property that defines which sub-element name definitions should be used for SE labels displayed to the particular user.
Valid settings:
v 1 - Use the SEs' internal ALIAS field values (also dubbed "SE Labels").
v 2 - Use the SEs' internal NAME field values.
v 1771 - Use the value defined in the
"customerFacingName" Property for each SE.
DV_UserShowCurrentPeriod
DataView user-scope property which controls access to active-period report viewing.
If equal to "true" or if undefined then the user is allowed to view reports on the current, active, possibly incomplete time period.
Set to "false" for a user to disable the current period view capability.
Report User Property Description
DV_UserEnableFavoriteLink
DataView user-scope property which enables the "Favorite Report" functionality (see DV_UserFavoriteURL).
Valid settings are the strings 'true' and 'false'. Any setting not equal to one of these values is interpreted as 'false'. If 'true', the
"Set Favorite Report" icon and the "Goto Favorite Report" icon are displayed on the portal. If 'false', then these icons are not displayed and the feature is disabled.
DV_UserFavoriteURL DataView user-scope property that specifies a user's "Favorite" report. The value of this property is a URL that generates a DataView report.
DV_UserWelcomeReporter DataView user-scope property that specifies a Welcome Reporter, or a "home" page, for a user. The value of this user property is a DataView reporter ID. Immediately following a user's initial Portal login, this Welcome Reporter is generated, so long as for that user no "Favorite Reporter"is defined and active (see
DV_UserFavoriteURL and DV_UserEnableFavoriteLink).
DV_UserLoginName DataView user-scope property that can be set with the login name attributed to a DataView user. This Property is used for informational display on Reporter summary headings only.
DV_UserName DataView user-scope property that can be
set with the name attributed to a DataView user. This Property is used for informational display on Reporter summary headings only.
DV_UserProbeConfigAccess
Can have 3 states
v read-write - the user has access to all probe configuration/management functionality.
v read-only - The user may access the configuration/management GUIs, but they cannot save, modify or delete any probes via the GUI.
v null (or other value) - the user is restricted from viewing either GUI. Null is the same as not defining the property.
Report User Property Description
DV_UserProbeFileConfigAccess
Can have 3 states
v read-write - the user has access to the file-based probe configuration functionality.
v read-only - The user may access the file-based probe configuration GUIs, but they cannot save, modify or delete any probes via the GUI.
v null (or other value) - the user is restricted from viewing the GUI.
DV_UserAccessScheduler Boolean that indicates if the user has permission to configure the Scheduler.
"False" by default
DV_UserGranularitySetting Boolean that indicates if the user has permission to set granularity. "False" by default (allows the user to access the granularity setting section of his preference page.)
DV_UserGranularity_DAILY User granularity setting for daily time series reports. The default is "raw"
DV_UserGranularity_WEEKLY User granularity setting for weekly time series reports. The default is "30min"
DV_UserGranularity_MONTHLY User granularity setting for monthly time series reports. The default is "1day"
DV_UserGranularity_QUARTERLY User granularity setting for quarterly time
DV_UserGranularity_QUARTERLY User granularity setting for quarterly time