NAME

alias_mgr - Alias Manager, used to create or remove Alias objects from the database


MODULE

base


SYNOPSIS

alias_mgr [--help] [--man] [--db connectstring] [--new <names...> [--collection <name>]] [--copy <from> <to> [--collection <name>]] [[--get] [--flat] <names...>] [(--set|--target) <node> <names...>] [--clear <names...>] [--destroy <names...> [--cleanup]] [--find] [--diff <name1> <name2>]


DESCRIPTION

This tool is used to manage Alias objects in the CIToolkit configuration database. It can be used to create new Aliases or remove existing ones, change or display the current target object, or duplicate an existing Alias with a new name.

alias_mgr must be passed the name of an existing Alias object, or the name of a collection which contains Alias objects, or the name of a new Alias to create.


OPTIONS

--new <names...> Create a new Alias object and add it to the database. May be used with --target and --collection.

--copy <from> <to> Create a new Alias object with the same target as an existing one. May be used with --collection.

--collection <name> When createing a new Alias with either --new or --copy, also add the new alias to the specified existing collection.

--get <names...> Display information about existing Alias objects. This is the default action

--flat Used with --get, print output in flat form appropriate to combine with other unix or CIT commands

--set <target> <names...>, --target <target> <names...> Set the Alias target to the specified object.

--clear <names...> Remove the target information from the specified object, leaving the Alias object in the database.

--destroy <names...> Remove the existing Alias object or objects from the database. If it was part of any collections, or referenced by other Aliases, then a warning of dangling references will be reported. Targets of removed Aliases will not themselves be removed.

--cleanup Used with --destroy, remove all references (Aliases or Collection membership) to the removed Alias, instead of warning about dangling references.

--find List all Alias objects in the database. Might be slow for very large databases as every object must be fetched and checked to see if it is an alias. (may not be combined with other options)

--diff <name1> <name2> Display the differences between two Alias objects. (may not be combined with other options)

--db <connectstring> Database type and connection information. For GDBM, "GDBM:" followed by the filename of the cluster database to use. For LDAP, the syntax is "LDAP:host:port:dbname"

--help Print extended usage information

--man Print this manpage.


NOTES

Unless noted above, multiple actions can be taken with one command. For example, the following will create a new Alias named "foo", set it's target to "node1", add it to a Collection named "rack1", and then display the new Alias object in single-line form:

  # alias_mgr --new foo --target node1 -c rack1 --get --flat

Regardless of the order of commands on the command line, actions are always taken in the following order:

  find, diff, copy, new, destroy, clear, set, get

If only --find, --diff, or --get is used, then the database will be opened read-only. Otherwise, it will be locked for read-write access.


FILES

The default paths for location of the cluster configuration database, cloned directories, supporting libraries, and other settings are recorded in the CConf.pm config file. Set the environment variable CLUSTER_CONFIG to the location of CConf.pm, or use the default of /cluster/config


SEE ALSO

device_mgr, collection_mgr, db_mgr, lookup