Moab Workload Manager
Home Up

mcredctl

 (Moab Credential Control)

Synopsis

mcredctl [-d credtype[:credid]]
         [-h credtype:credid] [-l credtype]
         [-q {role|limit|profile|accessfrom|accessto} 
             credtype[:credid]][--format=xml]
         [-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

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).
-d — DESTROY
Format: <TYPE>:<VAL>
Default: ---
Description: Purge a credential from moab.cfg (does not delete credential from memory).
Example: 
> mcredctl -d user:john

All references to USERCFG[john] will be commented out of moab.cfg)
   
-l — LIST
Format: <TYPE>
Default: ---
Description: List the various sub-objects of the specified credential (format in XML).
Example: 
> mcredctl -l user --format=xml

List all users within Moab in XML)

> mcredctl -l group --format=xml

List all groups within Moab in XML)
   
-q — QUERY
Format: { role | accessfrom | accessto | limit | profile | policies}

    limit  <TYPE>
    policies  <TYPE>
    role  USER:<USERID>
    profile  <TYPE>[;<VAL>]
    accessfrom  <TYPE>[:<VAL>]
    accessto  <TYPE>[:<VAL>]
Default: ---
Description: Display various aspects of a credential (formatted in XML).
Example: 
> 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)

Credential Statistics XML Output

Credential statistics can be requested as XML (via the --format=xml argument) and will be written to STDOUT in the following format:

> mcredctl -q profile user --format=xml -o time:1182927600,1183013999

<Data>
  <user ...> 
    <Profile ...>
    </Profile>
  </user>
</Data>

Example 1

> mcredctl -d group:john

GROUPCFG[john] Successfully purged from config files

Example 2

> mcredctl -l user --format=xml

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

Example 3

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

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

See Also

Home Up