Commands - mcredctl
Moab Workload Manager®

mcredctl

(Moab Credential Control)

Synopsis

mcredctl [-c credtype[:credid]] [-d credtype[:credid]] 
         [-h credtype:credid] [-l credtype] 
         [-q {role|limit|profile|accessfrom|accessto} credtype[:credid]] 
         [-r {stats|credits} credtype[:credid]]

Overview

The mcredctl command controls various aspects about the credential objects within Moab.  It can be used to display configuration, limits, roles, and relationships for various moab credential objects.

Arguments

-c <CREDTYPE>[:<CREDID>] // config
-d <CREDTYPE>:<CREDID> // destroy
-l <CREDTYPE> // list
-q <ASPECT> <CRED> (See below) // query

NOTE:  In all cases <CREDTYPE> is one of acct, group, user, class, or qos.
NOTE:  In most cases it is necessary to use the --format=xml flag in order to print the output (see examples below for specific syntax requirements).

Name Format Default Description Example
CONFIG <TYPE>[:<VAL>] --- Queries the configuration of the specified credential. (Format in XML) mcredctl -c user:bob --format=xml
 
(user bob's configuration will be returned in XML)
 
mcredctl -c acct --format=xml
 
(all account configurations will be returned in XML)
DESTROY <TYPE>:<VAL> --- Purge a credential from moab.cfg (does not delete credential from memory). mcredctl -d user:john
 
(all references to USERCFG[john] will be commented out of moab.cfg)
LIST <TYPE> --- List the various sub-objects of the specified credential. (Format in XML) mcredctl -l user --format=xml
 
(list all users within Moab in XML)
 
mcredctl -l group --format=xml
 
(list all groups within Moab in XML)
QUERY { role | accessfrom | accessto | limit | profile}

    limit  <TYPE>
    role  USER:<USERID>
    profile  <TYPE>[;<VAL>]
    accessfrom  <TYPE>[:<VAL>]
    accessto  <TYPE>[:<VAL>]
--- Display various aspects of a credential. (Format in XML) mcredctl -q role user:bob --format=xml
 
(view user bob's administrative role within Moab in XML)
 
mcredctl -q limit acct --format=xml
 
(display limits for all accounts in XML)

Example 1

> mcredctl -c user:john --format=xml

<Data><user ADEF="live" ALIST="live" ENABLEPROFILING="true" ID="john" QDEF="high" 
QLIST="high"><limits HLAJobs="10" SLAJobs="10"></limits><fs target="25.00 "></fs></user></Data>

Example 2

> mcredctl -d group:john --format=xml

GROUPCFG[john] Successfully purged from config files

Example 3

> mcredctl -l user --format=xml

<Data><user ID="john"</user><user ID="john"></user><user ID="root"></user><user ID="dev"></user></Data>

Example 4

> mcredctl -q role user:john --format=xml

<Data><user ID="test" role="admin5"></user></Data>