NAME
mxcollection - add, list, modify, or remove collections and members of
collections in Systems Insight Manager
SYNOPSIS
mxcollection -a -f filename
mxcollection -a mem -f filename
mxcollection -m mem -f filename
mxcollection -d existcollname
mxcollection -r mem -f filename
mxcollection -ln
mxcollection -lf existcollname [-b encoding]
mxcollection -mv existcollname -from fromparentcollname -to
toparentcollname [-branch sysbranch|evbranch]
mxcollection -cp existcollname -name newcollname -to toparentcollname
[-branch sysbranch|evbranch]
mxcollection -a combo newcombocollname -syscoll systemcollname -evcoll
eventcollname -parent toparentcollname [-branch sysbranch|evbranch]
DESCRIPTION
The mxcollection command allows a Systems Insight Manager user to add,
list, modify or remove collections in Systems Insight Manager.
IMPORTANT NOTE: In earlier releases of HP Systems Insight Manager,
categories could be created and manipulated with the mxquery command.
Since the HP SIM 5.0 and later release, collections are an extension
of categories, and are managed with the mxcollection command.
Collections are added by mxcollection command allows you to manage
members individually. You must continue to use mxquery command to
manage collections which are added by attributes.
The (mxcollection -a -f filename) form of mxcollection allows the user
to add collections and members in collections. Systems, queries and
other collections are possible members of collections. The
information regarding the collection is provided in a collection
schema file (see mxcollection(4)) and allows the user to add one or
more Systems Insight Manager collections.
During an add operation, Systems Insight Manager only adds collections
whose names do not reference collections and node groups currently in
the Systems Insight Manager repository. If Systems Insight Manager
detects a duplicate name, Systems Insight Manager will skip the
duplicate collection, but continue to add all non-duplicate
collections. Skipping duplicate collections in this case does not
affect the exit code.
The (mxcollection -a mem -f filename form of mxcollection allows the
user to add one or more members to existing collections. When
modifying a collection, the user must either be the collection's owner
or be a full rights user.
The (mxcollection -m mem -f filename) form of mxcollection allows the
user to modify the properties of one or more Systems Insight Manager
collection members specified in the xml file. When modifying a
collection and its contents, the user must either be the collection's
owner or be a full rights user.
The (mxcollection -d existcollname) form of mxcollection allows the
user to delete Systems Insight Manager collections. Only a full
rights user or the collection owner may delete a collection. If the
user specifies a collection name that does not correspond to a
collection in Systems Insight Manager, Systems Insight Manager
notifies the user that it cannot delete the collection. Collections
can not be deleted if they are used by Tasks, Report, Authorization,
or the status panel. Collections can not be deleted if they still
contain members in them.
The (mxcollection -r mem -f filename) form of mxcollection allows the
user to remove members from collection specified in the xml file .
Only a full rights user or the collection owner may remove contents
from a collection. Queries or sub-collections can not be removed from
the specified collection if they are not members of other collections.
The (mxcollection -ln) form of mxcollection allows the user to list
all Systems Insight Manager collection names in a tree hierarchical
form. It does not list collections which are added by attributes.
Collections that are added by attributes can be listed by (mxquery
-ln) command.
The (mxcollection -lf existcollname [-b encoding]) form of
mxcollection allows the user to write to stdout a complete Systems
Insight Manager collection definition (see mxcollection(4)) for the
specified Systems Insight Manager collection.
The (mxcollection -mv existcollname -from fromparentcollname -to
toparentcollname [-branch sysbranch|evbranch] ) form of mxcollection
allows the user to move an existing collection from its current parent
-from to another existing collection -to. The [-branch] option allows
you to specify collections in the system or event branch.
The (mxcollection -cp existcollname -name newcollname -to
toparentcollname [-branch sysbranch|evbranch] ) form of mxcollection
allows the user to copy an existing collection to a parent collection
-to with the specified new collection name -name. The [-branch] option
allows you to specify collections in the system or event branch.
The (mxcollection -a combo newcombocollname -syscoll systemcollname
-evcoll eventcollname -parent toparentcollname [-branch
sysbranch|evbranch]) form of mxcollection allows the user to create a
new combination collection which has the specified system collection
name (-syscoll) and event collection name (-evcoll) to an existing
parent collection (-to). The event collection name must be a
collection name created by attributes. The [-branch] option allows you
to specify collections in the system or event branch.
Options
mxcollection recognizes the following options:
-a Indicates that one or more Systems Insight Manager
collections, specified in a collection definition
file are to be added.
-a mem Indicates that one or more Systems Insight Manager
members are to be added to collections defined in
the specified collection definition file.
-m mem Indicates that one or more Systems Insight Manager
collection members are to be modified by the
definition in the specified collection definition
file.
-r mem Indicates that one or more Systems Insight Manager
members are to be removed specified in the
collection definition file.
-d existcollname
Indicates that the specified Systems Insight
Manager collection is to be deleted.
-f filename Specifies the path and name of a file that
contains the definition of one or more Systems
Insight Manager collections and members to be
added, modified, or removed. It must be specified
with (-a), (-a mem), (-m mem) or (-r mem) option.
-lf existcollname
Displays a file-formatted listing of Systems
Insight Manager collections.
-ln Displays the names of Systems Insight Manager
collections in a tree hierarchical form.
-b encoding Specifies the character encoding for an XML file
when used in conjunction with the -lf option.
-mv existcollname
Moves an existing collection from its current
parent collection to another collection. The
branch option specifies the branch name for this
operation
-from fromparentcollname
Specifies the from parent collection name. It
must be used with (-mv) option
-parent toparentcollname
Specifies an existing collection name to be the
parent collection name. This option is used along
with (-a como) option
-to toparentcollname
Specifies an existing collection name to be the
parent collection name. This option is used along
with (-mv), (-cp) options
-cp existcollname
Makes a copy of an existing collection, place it
under an parent collection with the specified new
collection name. The branch option specifies the
branch name for this operation
-name newcollname
Specifies a new collection name. It is used with
(-cp) option.
-a combo newcombocollname
Creates a new combination collection with one
system collection and one event collection with
the specified new collection name.
-syscoll systemcollname
Specifies new combination collection with one
system collection and one event collection. It is
be used with (-a combo) option.
-evcoll eventcollname
Specifies an existing event collection. The event
collection must be the collection specified by
attributes. This option is used with (-a combo)
option
-branch sysbranch|evbranch
Specifies the branch name for indicating
collections are either in the system branch or
event branch. It is used in conjunction with the
(-mv), (-cp) or (-a combo) option. Valid values
for the -branch option are "sysbranch" and
"evbranch". This option is optional for
collections in the system branch, but it must be
specified for collections in the event branch
using the "evbranch" value. If nothing is
specified for the branch option, it defaults to
the system branch.
RETURN VALUE
Upon completion, mxcollection returns:
0 The operation completed successfully.
2 A command-line syntax error was encountered.
-1 An error occurred during operation.
AUTHOR
mxcollection was developed by the Hewlett-Packard Company.
SEE ALSO
mxcollection(4)