mcredctl

4.0 Scheduler Commands > Commands > mcredctl

mcredctl

Synopsis

mcredctl [-d credtype[:credid]] [-h credtype:credid] [-l credtype] [-q {role|limit|profile|accessfrom|accessto|policies} credtype[:credid]] [--format=xml] [-r {stats|credits|fairshare} credtype[:credid]] [-t <STARTTIME>[,<ENDTIME>]

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

In all cases <CREDTYPE> is one of acct, group, user, class, or qos.

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>
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)

-h - HOLD
Format	<TYPE>:<VAL>
Description	Toggles whether a given credentials' jobs should be place on hold or not.
Example	> mcredctl -h user:john User [john] will be put on hold.

-l - LIST
Format	<TYPE>
Description	List the various sub-objects of the specified credential.
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>]
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 > mcredctl -q policies user:bob View limits organized by credential for user bob on each partition and resource manager

-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>]

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

> mcredctl -q policies user:bob

View limits organized by credential for user bob on each partition and resource manager

-r - RESET
Format	<TYPE>
Description	Resets the credential within Moab.
Example	> mcredctl -r user:john Resets the credential of user john

-t - TIMEFRAME
Format	<STARTTIME>[,<ENDTIME>]
Description	Can be used in conjunction with the -q profile option to display profiling information for the specified timeframe.
Example	> mcredctl -q profile user -t 14:30_06/20

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 4-6: Deleting a group

> mcredctl -d group:john
GROUPCFG[john] Successfully purged from config files

Example 4-7: List users in XML format

> 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-8: Display information about a user

> mcredctl -q role user:john --format=xml
<Data><user ID="test" role="admin5"></user></Data>