gdmo(n) Tnm Tcl Extension gdmo(n)_________________________________________________________________NAMEgdmo - A Tcl interface to GDMO definitions.
_________________________________________________________________DESCRIPTION
The gdmo Tcl command allows to access definitions conform-
ing to the Guidelines for the Definition of Managed
Objects (GDMO). The integrated GDMO parser converts GDMO
definitions into an internal representation which can be
queried using the gdmo Tcl command.
GDMO COMMANDgdmo load path
Parse the GDMO file given by path and store its
content into internal structures. path may be an
absolute or relative path to the desired file and
the tilde ~ is also allowed for starting at an
users home directory.
Example: gdmo load ~idefix/GDMO/example.gdmo
gdmo info option
Show a list of all sub-options that option under-
stand, where option is one of the following: class,
package, parameter, namebinding, attribute, group,
action, notification, behaviour.
Example: gdmo info class
exist superior mandatory conditional oid
gdmo class ?label option?
Get the stored information for the MANAGED OBJECT
CLASS templates. If used without the optional
parameters, it shows a list of stored class-labels.
If used with the optional parameters, label should
be one of the stored class-labels (gdmo class) and
option should be a valid option (gdmo info class).
The available options are:
exist Returns "1" if the definition for the
given class-label exist, else it returns
"0". (that is the class-label is refer-
enced, but there is no definition for it)
Tnm 1
gdmo(n) Tnm Tcl Extension gdmo(n)
superior Returns a list of class-labels that are
superclasses to the given class-label.
(DERIVED FROM)
mandatory Returns a list of package-labels specify-
ing the behaviour that characterizes all
instances of the given class-label.
(CHARACTERIZED BY)
conditional
Returns a list which elements are a pair
of package-label and condition-definition
that are present in instances of the
class under the given condition. (CONDI-
TIONAL PACKAGES, PRESENT IF)
oid Returns a list which parts form the
object-identifier value which identifies
to the managed object class definition.
(REGISTERED AS)
gdmo package ?label option?
Get the stored information for the PACKAGE tem-
plates. If used without the optional parameters, it
shows a list of stored package-labels. If used with
the optional parameters, label should be one of the
stored package-labels (gdmo package) and option
should be a valid option (gdmo info package).
The available options are:
exist Returns "1" if the definition for the
given package-label exist, else it
returns "0". (that is the package-label
is referenced, but there is no definition
for it)
behaviours
Returns a list of behaviour-definition-
label which define the behaviour that is
included in the package. (BEHAVIOUR)
attributes
Returns a list, which elements are a list
of attribute-label followed by a complex
Tnm 2
gdmo(n) Tnm Tcl Extension gdmo(n)
propertylist and a list of parameter-
labels, the package contains.
(ATTRIBUTES)
groups Returns a list, which elements are a list
of group-label followed by a list of
attribute-labels, the package contains.
(ATTRIBUTE GROUP)
actions Returns a list, which elements are a list
of action-label followed by a list of
parameter-labels, the package contains.
(ACTIONS)
notifications
Returns a list, which elements are a list
of notification-label followed by a list
of parameter-labels, the package con-
tains. (NOTIFICATIONS)
oid Returns a list which parts form the
object-identifier the package-label is
REGISTERED AS.
gdmo parameter ?label option?
Get the stored information for the PARAMETER tem-
plates. If used without the optional parameters, it
shows a list of stored parameter-labels. If used
with the optional parameters, label should be one
of the stored parameter-labels (gdmo parameter) and
option should be a valid option (gdmo info parame-
ter).
The available options are:
exist Returns "1" if the definition for the
given parameter-label exist, else it
returns "0". (that is the parameter-label
is referenced, but there is no definition
for it)
context Returns a context-keyword or a context-
type which is one of ACTION-INFO, ACTION-
REPLY, EVENT-INFO, EVENT-REPLY or SPE-
CIFIC-ERROR. (CONTEXT)
Tnm 3
gdmo(n) Tnm Tcl Extension gdmo(n)
choice Returns a list with two elements, one of
which is empty. If the first element is
not empty it is a type-reference (WITH
SYNTAX), otherwise the second element is
not empty and is an attribute-label
(ATTRIBUTE). The given list specify the
parameter.
behaviours
Returns a list of behaviour-definition-
labels that applies to the use of the
parameter. (BEHAVIOUR)
oid Returns a list which parts form the
object-identifier the parameter-label is
REGISTERED AS.
gdmo namebinding ?label option?
Get the stored information for the NAME BINDING
templates. If used without the optional parameters,
it shows a list of stored name-binding-labels. If
used with the optional parameters, label should be
one of the stored name-binding-labels (gdmo name-
binding) and option should be a valid option (gdmo
info namebinding).
The available options are:
exist Returns "1" if the definition for the
given name-binding-label exist, else it
returns "0". (that is the name-binding-
label is referenced, but there is no def-
inition for it)
subordinate
Returns a list with two elements, the
first is an class-label of the class that
is named by the superior object class and
the second is "1", if the name binding
applies to all subclasses of the speci-
fied managed object class and "0" other-
wise. (SUBORDINATE OBJECT CLASS)
superior Returns a list with two elements, the
first is an class-label of the class that
names the subordinate object class and
Tnm 4
gdmo(n) Tnm Tcl Extension gdmo(n)
the second is "1", if the name binding
applies to all subclasses of the speci-
fied managed object class and "0" other-
wise. (NAMED BY SUPERIOR OBJECT CLASS)
attribute Returns the attribute-label that shall be
used, in the context of this name bind-
ing, to construct the relative distin-
guished name for instances of the managed
object class defined by subordinate.
(ATTRIBUTE)
behaviours
Returns a list of behaviour-definition-
label that identifies the behaviour defi-
nition concerned for this name binding.
(BEHAVIOUR)
create Returns a list of two elements, the first
element is the create-modifier(s) (WITH-
REFERENCE-OBJECT, WITH-AUTOMATIC-
INSTANCE-NAMING) and the second element
is a list of parameter-labels. (CREATE)
delete Returns a list of two elements, the first
element is the delete-modifier (ONLY-IF-
NO-CONTAINED-OBJECTS, DELETES-CONTAINED-
OBJECTS) and the second element is a list
of parameter-labels. (DELETE)
oid Returns a list which parts form the
object-identifier the name-binding-label
is REGISTERED AS.
gdmo attribute ?label option?
Get the stored information for the ATTRIBUTE tem-
plates. If used without the optional parameters, it
shows a list of stored attribute-labels. If used
with the optional parameters, label should be one
of the stored attribute-labels (gdmo attribute) and
option should be a valid option (gdmo info
attribute).
The available options are:
Tnm 5
gdmo(n) Tnm Tcl Extension gdmo(n)
exist Returns "1" if the definition for the
given attribute-label exist, else it
returns "0". (that is the attribute-label
is referenced, but there is no definition
for it)
choice Returns a list with two elements, one of
which is empty. If the first element is
not empty it is an attribute-label
(DERIVED FROM), otherwise the second ele-
ment is not empty and is a type-reference
(WITH ATTRIBUTE SYNTAX). The given list
specify the attribute.
matchesfor
Returns a list of value matching types.
The value matching types are EQUALITY,
ORDERING, SUBSTRINGS, SET-COMPARISON and
SET-INTERSECTION. (MATCHES FOR)
behaviours
Returns a list of behaviour-definition-
labels that specify the behaviour of the
attribute. (BEHAVIOUR)
parameters
Returns a list parameter-labels that
specify attribute-specific error parame-
ters associated with management opera-
tions on the attribute type used for pro-
cessing failures. (PARAMETERS)
oid Returns a list which parts form the
object-identifier the attribute-label is
REGISTERED AS.
gdmo group ?label option?
Get the stored information for the ATTRIBUTE GROUP
templates. If used without the optional parameters,
it shows a list of stored group-labels. If used
with the optional parameters, label should be one
of the stored group-labels (gdmo group) and option
should be a valid option (gdmo info group).
The available options are:
Tnm 6
gdmo(n) Tnm Tcl Extension gdmo(n)
exist Returns "1" if the definition for the
given group-label exist, else it returns
"0". (that is the group-label is refer-
enced, but there is no definition for it)
attributes
Returns a list of attribute-labels that
constitute the group. (GROUP ELEMENTS)
fixed Returns "1", if the FIXED-token has been
given in the attribute group template and
"0" otherwise. (FIXED)
description
Returns a string that describes the
attribute group. (DESCRIPTION)
oid Returns a list which parts form the
object-identifier the group-label is REG-
ISTERED AS.
gdmo action ?label option?
Get the stored information for the ACTION tem-
plates. If used without the optional parameters, it
shows a list of stored action-labels. If used with
the optional parameters, label should be one of the
stored action-labels (gdmo action) and option
should be a valid option (gdmo info action).
The available options are:
exist Returns "1" if the definition for the
given action-label exist, else it returns
"0". (that is the action-label is refer-
enced, but there is no definition for it)
behaviours
Returns a list of behaviour-definition-
labels which define the behaviour of the
action. (BEHAVIOUR)
mode Returns "1", if the MODE CONFIRMED-token
has been given in the action template and
"0" otherwise. (FIXED)
Tnm 7
gdmo(n) Tnm Tcl Extension gdmo(n)
parameters
Returns a list of parameter-labels that
identify the action information or action
reply parameters, or processing failures
associated with the action type. (PARAME-
TERS)
infosyntax
Returns a type-reference that identifies
the ASN.1 data type that describes the
structure of the action information
parameter that is carried in management
protocol. (WITH INFORMATION SYNTAX)
replysyntax
Returns a type-reference that identifies
the ASN.1 data type that describes the
structure of the action reply parameter
that is carried in management protocol.
(WITH REPLY SYNTAX)
oid Returns a list which parts form the
object-identifier the action-label is
REGISTERED AS.
gdmo notification ?label option?
Get the stored information for the NOTIFICATION
templates. If used without the optional parameters,
it shows a list of stored notification-labels. If
used with the optional parameters, label should be
one of the stored notification-labels (gdmo notifi-
cation) and option should be a valid option (gdmo
info notification).
The available options are:
exist Returns "1" if the definition for the
given notification-label exist, else it
returns "0". (that is the notification-
label is referenced, but there is no def-
inition for it)
behaviours
Returns a list of behaviour-definition-
labels which shall specify the circum-
stances under which a notification of the
Tnm 8
gdmo(n) Tnm Tcl Extension gdmo(n)
type is generated. (BEHAVIOUR)
parameters
Returns a list of parameter-labels asso-
ciated with the notification type.
(PARAMETERS)
infosyntaxandids
Returns a list with a type-reference as
the first element and if present the sec-
ond element is a list of field-name and
attribute-label pairs. (WITH INFORMATION
SYNTAX ... [AND ATTRIBUTE IDS])
replysyntax
Returns a type-reference that identifies
the ASN.1 data type that describes the
structure of the notification reply that
is carried in management protocol. (WITH
REPLY SYNTAX)
oid Returns a list which parts form the
object-identifier the notification-label
is REGISTERED AS.
gdmo behaviour ?label option?
Get the stored information for the BEHAVIOUR tem-
plates. If used without the optional parameters, it
shows a list of stored behaviour-labels. If used
with the optional parameters, label should be one
of the stored behaviour-labels (gdmo behaviour) and
option should be a valid option (gdmo info
behaviour).
The available options are:
exist Returns "1" if the definition for the
given behaviour-label exist, else it
returns "0". (that is the behaviour-label
is referenced, but there is no definition
for it)
definition
Returns a textual definition of the
behaviour-label. (DEFINED AS)
Tnm 9
gdmo(n) Tnm Tcl Extension gdmo(n)SEE ALSOscotty(1), Tcl(n)AUTHORS
Michael Kernchen <kernchen@ibr.cs.tu-bs.de>
Juergen Schoenwaelder <schoenw@cs.utwente.nl>
Tnm 10