espconfig(1)espconfig(1)NAMEespconfig is a utility that enables you to configure ESP from the command
line. This utility bypasses the ESP webserver and interacts directly
with the ESP database.
To specify a client system from an SGM server, use the -sgmclient option
to specify the client alias or the -sysid option to specify the client
system id. Use only one of these options at a time.
INFORMATION COMMANDSSYNOPSISespconfig-help [<prototype>]
espconfig-spec
espconfig-version
espconfig-espversion [-sgmclient <client alias>|-sysid <system ID>]
DESCRIPTION
The espconfig-help command prints the list of command specifications.
The optional <prototype> parameter lists only the commands where
<prototype> matches some substring in the specification text. For
example, espconfig-help add lists all commands that contain the
character sequence 'add' in the specification.
The espconfig-spec command prints all commands in the way the command
line is parsed to match the specification.
The espconfig-version command displays the version of the espconfig
application with the date of the build.
The espconfig-espversion command displays the version number of ESP on
the local system. To obtain the version of ESP running on a client,
specify the client alias or client system ID.
espconfig formats output to fit to screen width. If the width cannot be
obtained, output is formatted at 80 columns wide.
EVENT CONFIGURATIONSYNOPSISespconfig-show evtype {-tid <type id>
|-td <type description>
[-sgmclient <client alias>]
espconfig-list evtype [-cid <class id>
|-cd <class description>]
[-enable|-disable]
[-log|-nolog]
[-sgmclient <client alias>]
espconfig-add evtype -td <type description>
{-cid <class id> | -cd <class description>}
[-throttle <throttle value>]
[-enable|-disable]
[-log|-nolog]
Page 1
espconfig(1)espconfig(1)
[-acfreq <action frequency value>]
[-acid <action id>
|-acd <action description>]
[-pri <priority>]
[-fac <facility>]
[-appname <app. name>]
[-regexp <reg. expression>]
[-prfid <profile id>
|-prfn <profile name>]
[-sgmclient <client alias>
|-sysid <client system id>]
espconfig-update evtype -tid <type id>
[-cid <class id>
|-cd <class desc>]
[-sgmclient <client alias>
|-sysid <client system id>]
[-td <type desc>]
[-throttle <value>]
[-enable|-disable]
[-log|-nolog]
[-acfreq <action frequency value>]
[-acid <action id>
|-acd <action description>]
[-pri <priority>]
[-fac <facility>]
[-appname <app. name>]
[-regexp <reg. expression>]
[-prfid <profile id>
|-prfn <profile name>
|-noprfid <profile id>
| -noprfn <profile name>]
espconfig-delete evtype {-tid <type id>
|-td <type description>}
[-sgmclient <client alias>
|-sysid <client system id>]
espconfig-subscribe evtype [-cid <class id>
|-cd <class desc>]
[-tid <type id>
|-td <type desc>]
[-pri <priority>]
[fac <facility>]
[appname <application name>]
[-sgmclient <client alias>
|-sysid <client system id>]
espconfig-unsubscribe evtype [-cid <class id>
|-cd <class desc>]
[-tid <type id>
|-td <type desc>]
[-pri <priority>]
[fac <facility>]
[appname <application name>]
[-sgmclient <client alias>
Page 2
espconfig(1)espconfig(1)
|-sysid <client system id>]
espconfig-add evclass [-cid <class id>]
-cd <class desc>
[-sgmclient <client alias>
|-sysid <client system id>]
espconfig-update evclass -cid <class id>
-cd <class description>
[-sgmclient <client alias>
|-sysid <client system id>]
espconfig-delete evclass {-cid <class id>
|-cd <class description>}
[-sgmclient <client alias>
|-sysid <client system id>]
espconfig-list evclass
DESCRIPTION
The -show evtype command shows all fields of the selected event type. The
-tid option specifies event type by type id. The
-td option specifies event type by type description. Only one of these
options needs to be specified at a time. If the type description is not
unique, all matching event types are printed.
The -list evtype command lists event type ids with event descriptions.
The -cid option displays a list by class id. The -cd option displays a
list by class description. Only one of these options needs to be
specified at a time. If both options are missing, all event types are
listed, unless a combination of -enable or -disable or -log or -nolog is
specified.
The -add evtype command adds a new event to ESP. The new event must be
specified by the key -td with the event type description. The type
description must be unique in the event class. The Event class must be
specified by the key -cid with class id or by the key -cd with class
description. The class id always defines an existing class, while the
class description can specify an existing class or a new class. -log
selects Automatic Call logging ( by default ); -nolog turns Automatic
Call Logging off. ESP assigns a new event type ID and displays its value
when the command completes.
The -update evtype command updates fields in an existing event type. The
event type must be specified by the type id with the -tid or by the type
description with the -td key.
The following options specify values for the new event in the -add evtype
command or updated values for the -update evtype command. If some options
are missing, default values are used by the -add evtype command. For the
-update evtype command, parameters that are not provided are left
unchanged. The options are:
-td <type description>
option enables you to change the type description in the -update
evtype command. Only custom-created event types can be updated
Page 3
espconfig(1)espconfig(1)
with this option.
-throttle <throttle value>
option sets or updates the throttle value, representing the
number of event occurrences prior to registration into the ESP
database. The default value is 1.
-enable | -disable
options define whether the event is enabled or disabled in a new
or updated event type. Only one of the these options can be
specified at a time. The default value is disabled.
-log | -nolog
options allow to enable or disable Automatic Call logging.
-acfreq <action frequency value>
option is used to set action frequency time. Action frequency
time is the amount of time that ESP pauses between multiple
executions of an action. The default value is 86400 seconds,
which specifies that the action will be executed once in 24
hours, regardless how of many times the event occurs on the
system during this period of time. Specifying a value of 0
disables the option.
-acid <action id>
-acd <action description>
options are used to associate an action with the created event
type or add another action associated with the updated event
type. Only one of the these options can be specified at a time.
If both options are missing, no actions are associated with the
new event type and actions associated with an existing event type
are left unchanged. The key -acid defines the new action by
action id, the while -acd the key defines the new action by
action description.
-noacid <action id>
-noacd <action description>
options are used to remove an action from updated event type.
Only one of these options can be specified at a time. If both
options are missing actions associated with updated event type
are left unchanged. The key -noacid defines dropped action by the
action id, while -noacd key defines it by the action description.
-pri <priority>
-fac <facility>
options are used to set priority and facility values. These
parameters are optional. The default value for each is -1 (not
set). If set, these values correspond to the values logged into
SYSLOG.
Page 4
espconfig(1)espconfig(1)-appname <app. name>
option is used to specify an application name if there is a need
to track an event using this parameter. If specified, this value
has to correspond to the value logged into SYSLOG.
-regexp <reg. expression>
option is used when there is no other way to uniquely track an
event. When specified, ESP uses this option as a primary
parameter for event tracking.
-prfid <profile id>
-prfn <profile name>
options are used to specify event profile. An event always
belongs to at least one profile. However, it is possible for one
event to belong to more then one event profile. When a new event
is added, one of these options has to be specified. Only one of
these options can be specified at a time. The -prfid key defines
profile by the profile id, while the -prfn key defines it by the
profile name.
-noprfid <profile id>
-noprfn <profile name>
options are used to remove an event from a profile. Only one of
these options can be specified at a time. If an event type
belongs to only one event profile, the profile cannot be removed.
The key -noprfid defines the profile by the profile id, while the
-noprfn key defines it by the profile name.
The -delete evtype command is used to delete events. Only custom-defined
events can be deleted. The event to be deleted must be uniquely specified
by the type id or the type description with the -tid or -td options. Only
one key can be specified at a time. The type id is unique for events;
however, the description can be the same across different event classes.
If the type description is not unique, then a table of all event types
matching the given description are listed, along with their type id's.
The user can then use the -tid key for the appropriate type for deletion.
If the type being deleted is the last in its class, then the class is
also removed.
To have ESP start monitoring events, the events must be subscribed. The
-subscribe evtype command is used to subscribe events. To select all
events in a class for subscription, specify the event class with the key
-cid with class id or with the key -cd with the class description. To
subscribe one event, use the key -tid with the type id or use the key -td
with the type description.
The -unsubscribe evtype command is used when it is no longer necessary
for Event Manager to monitor events. Events can be unsubscribed by class
using the key -cid with class id or by the key -cd with the class id;
events can be unsubscribed by event type using the key -tid with the
Page 5
espconfig(1)espconfig(1)
typeid or by the key -td with the type description. When one of the class
parameters is specified, all events of the specified class are
unsubscribed.
The -update evclass command can be used to update the class description
for custom-defined event classes. The -cid key specifies the selected
event class by its id. The -cd key specifies the new description for the
class.
The -delete evclass command can be used to delete custom-defined event
classes. Classes for deletion can be specified by the class id with the
-cid key or by class description with the -cd key. Only one of these keys
can be specified in the command line.
The -list evclass command is used to list event classes. The command
lists the event class ID and event class description.
The -delete events command is used to delete all event-related
structures: types, classes, actions and cross references.
EXAMPLES
1. espconfig-add evtype
-td "XXX diagnostic memory overflow"
-cd "XXX diagnostic"
2. espconfig-add evtype -td "XXX failure 0102"
-cd "XXX diagnostic"
3. espconfig-list evtype -cd "XXX diagnostic"
TypeId Type description
----------------------
8400000 "XXX diagnostic memory overflow"
8400001 "XXX failure 0102"
4. espconfig-update evtype -tid 8400001
-td "XXX diagnostic: data parity"
-acfreq 43200
-acd "Mail administrator"
5. espconfig-update evtype -tid 8400001
-enable -throttle 5
-noacd "Mail administrator"
-acd "Page owner"
6. espconfig-update evtype -tid 8400001
-acd "Mail owner"
Example 1 creates a new event type. Example 2 creates another event type
in an existing class. Example 3 gives the list of events (with type
ids). Example 4 updates the type description for the second event type,
associates an action to it, and sets the action frequency to 12 hours.
Example 5 removes an action and associates another action (with the
default 24 hours frequency) to the event. It also updates the throttle
value and enables the event type. Example 6 adds one more action to the
same event type.
Page 6
espconfig(1)espconfig(1)
Command lines are wrapped here only for display purposes.
EVENT ACTION CONFIGURATIONSYNOPSISespconfig-show evaction {-acid <action id>
|-acd <action description>}
espconfig-list evaction
espconfig-add evaction -acd <action description>
-act <action string>
[-enable|-disable]
[-user <name>]
[-tout <timeout value>]
espconfig-update evaction
{-acid <action id>
[-acd <new action description>] |
-acd <action description>}
[-act <action string>]
[-enable|-disable]
[-user <name>]
[-tout <timeout value>]
DESCRIPTION
The -show evaction command is used to show all fields of the selected
event action. The key -acid specifies the event action by action id. The
key -acd specifies the event action by the action description. Only one
of these keys can be specified at a time.
The -list evaction command is used to list event actions. The action ids
and action descriptions are listed.
The -add evaction command is used to create new actions. Adding an action
requires the action description and action string as mandatory
parameters. The action description is specified by the -acd key, while
the action string is specified by the -act key.
The -update evaction command can be used to update parameters that apply
to an existing action. The action to be updated can be selected by the
action id with the -acid key followed by a valid action id. In this case,
the optional -acd key specifies the updated action description. If he
f3-acid key is missing, then the -acd key is mandatory to specify the
updated action by action description.
The following options specify field values for a new action in the -add
evaction command or for an updated action in the -update evaction
command. If some options are missing for the -add evaction command,
default values are used. For the -update evaction command, missing fields
are left unchanged. The options are:
-act <action string>
option changes the action string in the -update evaction command.
For the -add evaction command, this key is mandatory.
Page 7
espconfig(1)espconfig(1)-enable | -disable
options define if the new or updated action is enabled or
disabled. Only one of the two options can be specified with the
command.
-user <name>
option defines the UNIX user name for a new or updated action.
The user's permissions are used to execute the action string. The
default user is 'nobody'.
-tout <timeout value>
option defines the timeout value within which the action being
executed must complete. If this timeout period is completed and
the action is still running, the action will be killed. The
default value is 0.
All actions on an SGM system are applicable to its clients.
IMPORTING AND EXPORTING EVENTSSYNOPSISespconfig -add|-load|-merge eventprofile <profile name>+|allprofiles
[-defaults]
[-dontsubscribe]
[-sgmclient <client alias>
|-sysid <client system id>]
espconfig -drop|-unload eventprofile <profile name>+|allprofiles
[-sgmclient <client alias>
|-sysid <client system id>]
espconfig -save|-refresh eventprofile [-defaults] <profile name> +|allprofiles
[-sgmclient <client alias>
|-sysid <client system id>]
espconfig-list eventprofile
[-sgmclient <client alias>
|-sysid <client system id>]
espconfig-showevents eventprofile <profile name>+
[-sgmclient <client alias>
|-sysid <client system id>]
DESCRIPTION
In general, ESP event profile filenames are located in the
/var/esp/init/eventprofiles directory, or for an SGM, in the
/var/esp/init/eventprofiles/<system name> directory. If an extension of
".esp" is not supplied, espconfig will append it. If a profile name is
supplied using an absolute path, the directory location will be removed
and the default directory will be prepended instead. For an SGM, a
specific system ID or alias must be specified by using the -sgmclient or
-sysid options.
The -load command clears the current event list and assigned actions from
the database and re-installs a new set of events and actions (if defined)
from the file profile name. If allprofiles is specified as a profile
name, the operation repeats for all profiles.
Page 8
espconfig(1)espconfig(1)
The -add command compares events in the ESP database and inserts only new
events that are being introduced from the file eventprofile name. If
allprofiles is specified as a f2profile name, the operation repeats for
all profiles.
The -merge command compares the events that are currently loaded in ESP
with an event profile data file and updates the events in ESP that are
different in the file eventprofile name. If allprofiles is specified as
a profile name, the operation repeats for all profiles.
The following options are available for the above commands:
-defaults
option used to override current values in the event profile with
the default ones. Original ESP profiles are stored separately and
used for this purpose.
-dontsubscribe
option is used add an event profiles to the ESP list without
subscribing them to the Event Manager for monitoring. By default,
events are subscribed when an event profile is loaded, added, or
merged.
The -drop command drops all events from the ESP database as defined by
the file eventprofile name. However, each profile that is loaded in the
database is first checked to determine if the event being dropped is part
of any other profile. If so, the event is not dropped. If allprofiles is
specified as a profile name, the operation repeats for all profiles.
The -unload command unloads event profiles without removing events from
the ESP event list. If allprofiles is specified as a profile name, the
operation repeats for all profiles.
The -save command saves the current ESP event list and assigned actions
in an event profile data file.
The -refresh command refreshes the ESP event list and assigned actions
from an event profile data file.
The -list command lists current ESP profiles and their load status.
IP ADDRESSES CONFIGURATIONSYNOPSISespconfig-enable ipaddr <ip address>...<ip address>
espconfig-disable ipaddr <ip address>...<ip address>
espconfig-delete ipaddr <ip address>...<ip address>
espconfig-list ipaddr <ip address>...<ip address>
[-enabled | -disabled]
Page 9
espconfig(1)espconfig(1)DESCRIPTION
The -enable command is used to enable access for specific IP addresses.
If an IP address from the specified list is already enabled, then its
status remains unchanged. Disabled IP addresses are enabled. If an IP
address is not already in the available list, then the IP address is
added to the ESP database in an enabled state. At least one <ip address>
must be provided.
The -disable command is used to disable access for specific IP addresses.
If an IP address was disabled before, its status is unchanged. Enabled
IP addresses are disabled. Non-existent IP addresses are added to the ESP
database in a disabled state. At least one <ip address> must be provided.
The -delete command is used to delete given IP addresses from the system.
At least one <ip address> must be provided.
The -list command is used to list IP addresses available in the system
and the state of the IP addresses (enabled or disable). If the ip address
list is not provided, all entries are listed. Providing the -enabled or
the -disabled option lists only addresses that are either enabled or
disabled.
USERS AND USER PERMISSIONS CONFIGURATIONSYNOPSISespconfig-add user -name <user name> [-p <password>]
espconfig-delete user -name <user name> [-p <password>]
espconfig-update user -name <user name> [-p <password>]
espconfig-list user [-name <user name>]
espconfig-createadmin
espconfig-add permdesc -perm <permission name>
-desc <permission description>
espconfig-delete permdesc -perm <permission name>
espconfig-list permdesc
[-perm <permission name>..<permission name>]
espconfig-add userperm [-name <user name>]
-perm <permission name>
espconfig-delete userperm [-name <user name>]
[-perm <permission name>]
espconfig-list userperm [-name <user name>]
[-perm <permission name>]
DESCRIPTION
The -add user command is used to add a new user to the system. The key
-name specifies the new user name. The key -p specifies the user
password. If the password key is missing, the command will prompt for a
non-echoed verified input for the password.
The -delete user command is used to delete a user from the system. The
key -name specifies the user name. The key -p specifies the user
password. If password key is not provided, the command will prompt for a
password in a non-echoed mode.
Page 10
espconfig(1)espconfig(1)
The -update user command is used to update the user password. The key
-name specifies the user name. The key -p specifies the new user
password. If the key -p is missing, then the command prompts for the
password in a non-echoed mode.
The -list user command is used to list the user(s). The key -name
specifies the user name. If the key -name is missing, all users are
listed.
The -createadmin command is used to create the default user
(administrator/partner) with all permissions.
The -add permdesc command is used to add new permissions into the system.
The key -perm defines the permission name and the key -desc defines the
permission description.
The -delete permdesc command is used to delete a permission from the
system. The key -perm defines the permission name.
The -list permdesc command lists the permissions available in ESP. The
key -perm defines the permission name. If the key -perm is not provided,
all permission descriptions are listed.
The -add userperm command is used to add permissions to a user. The key
-perm defines the permission name. The key -name defines the user name.
If the -name key is missing, then the permission is added to all the
users.
The -delete userperm command is used to remove permission(s) from a user.
The key -name defines the user name. If the -name key is missing, then
the specified permission is removed from all users. The key -perm defines
the permission to be removed. If the -perm key is missing, all
permissions are removed for the given user. If both keys are missing, all
permissions are removed from all users.
The -list userperm command is used to list user permissions. The key
-name defines the user name. If the -name key is missing, all users are
listed. The key -perm defines the permission. If the -perm key is
missing, all permissions are listed. If both keys are missing all
permissions are listed for all users.
ESP ARCHIVE MANAGEMENTSYNOPSISespconfig-list archive [<archive name> ..<archive name>]
espconfig-drop archive <archive name>
DESCRIPTION
The -list archive command is used to list ESP archives. Archives
specified in the command are listed. If the archive name is missing in
command line, all archives are listed. The list command displays the
archive name and date information for the archive.
Page 11
espconfig(1)espconfig(1)
The -drop archive command is used to drop an existing ESP archive.
ESP CUSTOMER PROFILE CONFIGURATIONSYNOPSISespconfig-create customer_profile
-fname <first name>
-lname <last name>
-phone <phone>
-email <email>
[-street1 <street address line1>]
[-street2 <street address line2>]
[-street3 <street address line3>]
[-city <city>]
[-state <state/province>]
[-zip <postal code>]
-country <country>
[-site_id <site id>]
espconfig-update customer_profile
[-fname <first name>]
[-lname <last name>]
[-phone <phone>]
[-email <email>]
[-street1 <street address line1>]
[-street2 <street address line2>]
[-street3 <street address line3>]
[-city <city>]
[-state <state/province>]
[-post <postal code>]
[-country <country>]
[-site_id <site id>]
espconfig-show customer_profile
DESCRIPTION
The -create command is used to create an ESP customer profile. The first
four options are mandatory in this command.
The -update command is used to update an existing ESP customer profile.
The first four parameters for this command are required.
The -show command prints the current customer profile information.
These commands use the following options:
-fname <first name>
option specifies the first name of the contact at the customer
site.
-lname <last name>
option specifies the last name of the contact at the customer
site.
Page 12
espconfig(1)espconfig(1)-phone <phone>
option specifies the phone number for the contact at the customer
site.
-email <email>
option specifies the email address of the contact at the customer
site.
-street1 <street address line1>
option specifies the line1 of the street address of the contact
at the customer site.
-street2 <street address line2>
option specifies the line2 of the street address of the contact
at the customer site.
-street3 <street address line3>
option specifies the line3 of the street address of the contact
at the customer site.
-city <city>
option specifies the city of the contact at the customer site.
-state <state/province>
option specifies the state or province of the contact at the
customer site.
-post <postal code>
option specifies zip/postal code of the contact at the customer
site.
-country <country>
option specifies the country of the contact at the customer site.
-site_id <site id>
option specifies the site id.
ESP GLOBAL CONFIGURATIONSYNOPSISespconfig-enable call_logging [-text|-comp_encoded]
[-sgmclient <client alias>
|-sysid <system id>]
espconfig-enable {event_registration|
event_throttling|
event_actions|
shutdown_reason}
[-sgmclient <client alias>
|-sysid <system id>]
espconfig-enable mail -from <email address>
[-email1 <email address>]
[-email2 <email address>]
espconfig-disable {call_logging|
Page 13
espconfig(1)espconfig(1)
event_registration|
event_throttling|
event_actions|
shutdown_reason}
[-sgmclient <client alias>
|-sysid <system id>]
espconfig-show {call_logging|
event_registration|
event_throttling|
event_actions|
shutdown_reason}
[-sgmclient <client alias>
|-sysid <system id>]
espconfig-show mail
espconfig-flushdb [-sysid <system id>
|-host <host name>]
[config|all]
espconfig-reconstructdb
DESCRIPTION
The -enable key enables the specified ESP feature(s), while the -disable
key disables feature(s). On an SGM, you can specify a system ID or client
alias. The features are the following:
call_logging
this feature specifies whether or not ESP should send email
messages to SGI about registered events. (Under specific service
contracts SGI uses this data to open trouble tickets and respond
to problems before the problems affect system availability.) When
call logging is enabled, the optional keys -text and
-comp_encoded define the email message format. The -text key
specifies to send messages in the plain text format, while the
-comp_encoded key specifies to send the messages in compressed,
encrypted and uuencoded format. Only one of the keys can be
specified in the command line. If both keys are missing, then
plain text format is assumed.
mail this feature specifies the value of the Mail sender. Email sent
to SGI will appear as sent from the root account or the user
specified via the key -from. The keys -email1 and -email2 specify
additional email addresses to send a message to. The format of
the message in the for -email1 is always plain text, and the
format of message for the -email2 is the same as the setting
provided by the option text or comp_encoded. Messages that are
received using the comp_encoded option may be decoded using the
amreceieve utility.
event_registration
this feature specifies whether or not ESP should register events.
Page 14
espconfig(1)espconfig(1)
event_throttling
this feature specifies whether or not ESP should throttle events.
event_actions
this feature specifies whether or not ESP should perform actions.
shutdown_reason
this feature specifies whether or not user will be prompted to
enter a reason when they shut down the system.
The espconfig-show mail command is used to view the current setting of
the e-mail parameter.
The espconfig-flushdb command is used to clear data registered
concerning the selected system, the current or client in the case of SGM
site. If espconfig is running on an SGM, the optional key -sysid defines
the client by specifying the system id to which the command applies. The
optional -host key is used to specify the client system by host name.
Only one of the keys needs to be provided on the command line. If neither
key is provided, then the system on which the command is being run is
affected. The client data is removed from SGM, but the client itself is
not affected. The keys [config|all] define data that is affected by the
command. Only one of the keys can be specified at a time. If both keys
are missing, all data except system configuration-related data is
cleared. The key config specifies to clear only configuration data. The
key all specifies to clear both types of data.
The espconfig-reconstructdb command reinitializes the ESP database to
its initial state. This command should be used with extreme caution as
all historical data will be lost. The entire ESP database is deleted and
recreated.
SYSTEM GROUP MANAGER(SGM) CONFIGURATION
SYNOPSISespconfig-show systems
espconfig-show sgmclients
espconfig-show sgmservers
espconfig-show system -host <host name>
|-sgmclient <client alias>
|-sysid <system id>
espconfig-set system -host <host name>
|-sysid <system id>
[-alias <new alias>]
[-group <group name>
|-gid <group id>]
espconfig-setnode system -sgmnode |-fullnode
espconfig-check system -sgmlicense |-update
espconfig-add sgmclient -alias <client alias>
-host <client hostname>
[-group <group name>
|-gid <group id>]
Page 15
espconfig(1)espconfig(1)
[-p <password>] [-v2 |-v3]
[-path <client reach path>]
espconfig-subscribe sgmclient -host <host name>
|-alias <client alias>
|-sysid <system id>
[-loadprofiles]
[-refreshprofiles]
[-lightnode |-fullnode]
[-force]
espconfig-unsubscribe sgmclient -host <host name>
|-alias <client alias>
|-sysid <system id>
[-force]
espconfig-update sgmclient -host <host name>
|-alias <client alias>
|-sysid <system id>
[-p <password>]
[-path <new path>]
[-lightnode |-fullnode]
espconfig-delete sgmclient -host <host name>
|-alias <client alias>
|-sysid <system id>
espconfig ping -sgmclient <client alias>
|-sysid <system id>
|-path <reach path>
[-v2]
espconfig-add sgmserver -host <SGM host name>
-p <communication password>
espconfig-update sgmkey -host <host name>
-p <comm. password>
[-pid <key ID>]
DESCRIPTION
System Group Manager(SGM) enables Embedded Support Partner to collect
various information about systems in a system group. It provides
functionality to :
- Register subscribed events that are detected on the
other systems in the group
- Execute actions for those events on a group manager
- Generate reports for a remote system or group of
systems
- Provide hardware and software information for any
system in the group (the System Configuration event
class must be subscribed)
- Provide availability information for any system in
the group or for a group of systems (the Availability
event class must be subscribed)
All components of SGM are installed on your system as a part of ESP.
However, a nodelocked license is required to allow ESP function as a
group manager. Without the license or with an expired license, Embedded
Page 16
espconfig(1)espconfig(1)
Support Partner cannot function in group manager mode. All SGM-related
operations (except configuring the system as a group member for another
Group manager) will be blocked. Use Key-O-Matic at the SGI Web site
(www.sgi.com) to obtain a permanent license, or contact the local SGI
support office for more information about obtaining a permanent license.
The -check system -sgmlicense command refreshes information about the SGM
license installed on system. This command must be executed after
installing or de-installing SGM license.
The espconfig-show systems command shows all systems and their
information, such as system ID, IP address, system hostname, alias and
system status (active/not active).
The espconfig-show sgmclients command does the same as the -show systems
command but for the clients only.
The espconfig-show sgmservers command displays information related to
the client's server(s), such as system ID, server's hostname and event
forwarding path.
The espconfig-show system command displays information about the system.
The following options specify field values for a system or a client when
SGM-related commands are executed. Only one of these options must be
specified.
-host <host name>
option specifies a system by its hostname.
-sgmclient <client alias>
option specifies a client by its alias.
-sysid <system id>
option specifies a system by its system ID.
The espconfig-check system -update command detects system changes.
The espconfig-set system command is used to set some system parameters.
Note, when this command is executed, previous values will be overwritten.
The following options specify updated values in the -set system command
and set new field values in the -add sgmclient command. The options are:
-alias <new or client alias>
option updates or sets the alias for a system or client.
-group <group name or descr.>
option updates or sets an existing or new group name to a system
or client.
Page 17
espconfig(1)espconfig(1)-gid <group id>
option updates or sets the group ID for a system or client. This
ID can be selected from the existing list of groups.
Use the following three steps to configure a System Group Manager for
remote event monitoring:
- Establish communication between the SGM group manager
and the SGM group member.
- Subscribe the client.
- Subscribe the events from the SGM client.
The system can be configured as an SGM server and/or a client to an
already functioning SGM server.
To enable a group manager to communicate with a group member, the
appropriate setup must be done both on the group member and group manager
sides. On the SGM Client (group member), register (declare) a selected
host as an SGM server (group manager) for this client. The SGM Client
allows communication only for registered SGM Servers. On the SGM Server
(group manager), do the following steps to register an SGM Client (group
member):
- set up the system as an SGM if you have not done this yet.
- add the selected host(s) as it's SGM Client (group member).
- subscribe added SGM Client(s).
The SGM Server can communicate only with registered SGM clients.
The espconfig-setnode system switches a system between SGM mode and
single system mode. -sgmnode configures a system as a SGM server if a
valid license is installed. -fullnode option returns system in its
original state. Note: Information about clients that were subscribed
while a system was an SGM server remains intact.
The espconfig-add sgmclient command adds a new SGM client (group member)
to a group manager. -alias <client alias> and -host <client hostname>
are required parameters. <client alias> is a name by which the group
member is known to group manager. This parameter can contain any non-
blank space characters, except single or double quotes. This entry must
be identical to the one that is specified on the group member side as the
<client alias> while registering the group manager. <client hostname> is
a fully qualified hostname of the system that is set up as a group
member. This hostname must be known to the group manager system.
Otherwise the -path <client reach path> parameter must be set. For an
ESP 3.0 client, -p <password> option can be ommitted if security is not
important. However, for an ESP 2.0 client, it is a required option. This
password is used by the client and server for mutual client-server
authentication. Therefore, if selected, the same password must be entered
on the client side for this system. The password must contain at least 8
characters. This password is maintained on a client-server pair basis.
If a new client is running ESP 2.0, the -v2 option must be specified and
Page 18
espconfig(1)espconfig(1)-path option cannot be used. Note: When a client is added, the
communication with the SGM server is established. However, monitoring
does not start unless the client is subscribed.
The espconfig-subscribe sgmclient command subscribes previously added
client. Profiles are not automatically loaded during subscription. Select
the -loadprofiles option to load profiles. If this option is not
specified during subscription, use the espconfig-load eventprofile
command. If the client was subscribed earlier, use the -refreshprofiles
option to ensure that all the latest events and event configurations are
available on the SGM server. Use the -fullnode option if a copy of
database is needed on a client side, or switch to a light node (no
database information on the client side) by selecting -lightnode option.
The espconfig-add sgmserver command registers a new SGM server (group
manager) on a group member. -host <SGM host name> is a full name of the
system that is set up as group manager and of which this system will be a
client. -p <communication password> is optional. It is used by the client
and server for mutual client-server authentication. Therefore, the same
password must be entered on the client side for this system. The password
must contain at least 8 characters. This password is maintained on a
client-server pair basis.
Important: It is strongly recommended that you do not create duplicate
hosts on a client or on a server side. It is strongly recommended that
you do not create cycles. For example, system B monitors system A, and
system A monitors system B. However, the following setup is acceptable:
System A monitors systems B and D, and system C monitors systems A and D.
The espconfig-update sgmclient command updates the password,
communication path, and node values for the client. If -p <password> is
used for client-server authentication, it must be updated for the client
and its SGM server simultaneously. The -path <new path> option resets
the communication path between an SGM server and its client. The
-lightnode and -fullnode commands update a client node state to a light
(no database on the client side) or full (a copy of database running on a
client side).
The espconfig-unsubscribe sgmclient command unsubscribes a client. When
a client is unsubscribed, ESP is not monitoring it, but all data ia still
available on the SGM server. The -force option unsubscribes a client from
an SGM server when communication cannot be established between a client
and SGM server. For example, when the client is physically removed.
The espconfig-delete sgmclient command deletes all data about
unsubscribed client from the SGM database.
The espconfig ping command verifies that ESP can establish communication
with the client. The -v2 option does the same thing with a client that
runs ESP 2.0 version.
Page 19
espconfig(1)espconfig(1)PERFORMANCE CONFIGURATIONSYNOPSISespconfig-on performance
espconfig-off performance
espconfig-list performance [-status|-enable|-disable]
espconfig-enable performance -pd {all|<pmie rule description>}
espconfig-disable performance -pd {all|<pmie rule description}>
DESCRIPTION
The espconfig-on performance and espconfig-off performance commands
stop and start pmie. Be aware that this affects pmie startup outside the
scope of ESP as well. This command actually performs a chkconfig pmie on
or off and stops or starts pmie.
The espconfig-list performance list if pmie is on or off ( -status ) and
rules. Keys like -enable or -disable can be used to control rules
selection. The default is all rules.
The espconfig-enable performance and espconfig-disable performance
commands allow 'all' or a list of pmie rules to be enabled or disabled.
Changes are effective immediately.
SYSTEM MONITORING CONFIGURATIONSYNOPSISespconfig monitor -list <service name>
espconfig monitor -show <service name> [-sgmclient <client alias>]
espconfig monitor -enable <service name> [-sgmclient <client alias>]
espconfig monitor -disable <service name> [-sgmclient <client alias>]
The espconfig monitor -list command lists all or selected services that
ESP can monitor. Output includes the service name abbreviation and a
description. The word HOST in the description is actually substituted
upon execution for each sgmclient host associated to that service.
The espconfig monitor -show command lists all services associated to all
systems or the selected host.
The espconfig monitor -enable and espconfig monitor -disable commands
enable the selected service to be enabled or disabled on all systems or
on the selected host.
SEE ALSOespreport(1)
Page 20
