MSHARE(1) User Contributed Perl Documentation MSHARE(1) NAME mshare - Displays resource allocation and usage information from the Moab database. While this utility is similar to the LCRM pshare utility, it does not support all the same options. SYNOPSIS mshare [-a account] [-u user] [-p partition] [-0] mshare -[t|T] account [-p partition] [-0] [-l levels] mshare -r account [-p hostname] [-0] mshare -h mshare -man DESCRIPTION mshare reads the Moab fairshare and generates share and usage reports to stdout. Information written depends on options specified on the command line. If the -a option is used, information about accounts is written. If the -u option is used, information about user allocations is written. If the -t or -T option is used, information about accounts and (in the case of the -t option) user allocations is written in such a manner as to show the tree structure of the database. If the -r option is used, information about the specified account and all its parents up through and including the root account is written. If none of the above options are used, then information about the calling user's allocations is written. Moab implements a "Fair Share" allocation scheme. The fair share system attempts to regulate short term "rate-of-delivery" to help assure that users get good response time and turn-around to the extent that they have been allocated access to compute resources. Users and groups of users (that is, within the context of accounts) are granted shares that represent their "claim" on the computing resources being managed by Moab. Each machine within the Moab domain is a member of one and only one resource partition. A resource partition may have one member computer or it may have many. Shares are allocated to each user and account for each resource partition. A share represents a user's or an account's claim on the computational resources available in a resource partition. A user or account may apply the shares allocated to it for a resource partition on any of the hosts in a resource partition. When an account is created or a user is permitted to use the resources granted to an account, shares are allocated to that account or user for that resource partition. The shares a user or account has, when divided by the total number of shares allocated to all its siblings, represents the portion of the shares granted to the parent account that are claimed by the user or account. Normalized shares represent the portion of the entire resource partition that the user or account has been allocated. Each user allocation and account has associated with it a "usage" value. This value is incremented whenever a user uses the resources of a computer. It is also "decayed" on a regular basis based on a "half- life decay" algorithm. If a usage value is not incremented during the half-life decay period, its value will be cut in half after that period. Moab regulates resource usage by assigning queued job priorities based on the discrepancy between the normalized shares and the actual usage. The information written is displayed in multi-column format. The headings for the columns are as follows (depending on whether the -u, the -a or -r, or the -t or -T option is used, respectively): FIELDS RESOURCE PARTITION: partition_name USERNAME ACCOUNT --------SHARES-------- ------USAGE------ ALLOCATED NORMALIZED NORMALIZED ACCOUNT PARENT --------SHARES-------- ------USAGE------ ALLOCATED NORMALIZED NORMALIZED U/A NAME A/P NAME --------SHARES-------- ------USAGE------ ALLOCATED NORMALIZED NORMALIZED The columns are relatively self-explanatory: SHARES ALLOCATED the share granted to the user or account which may be applied to the resource partition of which the specified or implied hostname is a member. SHARES NORMALIZED the share of the resource partition expressed as a portion of the total shares assigned to the resource partition. USAGE NORMALIZED the half-life decayed usage value expressed as a portion of the total usage on the resource partition being reported. The decay rate is set by a Moab manager and represents the amount of time which if an account or user allocation is not used, it will decay to half its starting value. U/A user name or account as appropriate A/P account or parent as appropriate OPTIONS -0 Do not list records that have 0 raw usage. -a account Information about the account is displayed. This option may not be used with the -r, -T or -t options. -h A usage summary message is displayed, and mshare terminates. -l levels The number of levels of a sub-tree to display if the -T or -t option is used. This option may not be used if neither the -t option nor the -T option is used. -p partition Will show allocation information for the resource partition of which hostname is a member. If this option is not used, the value for hostname is the host on which mshare is being executed. To see allocation information for all resource partitions in the Moab domain, use ALL as the hostname. -r account Records are written for the specified account and each of its parents up through and including the root account. This option may not be used with the -a, -T, -t or -u options. -T account Records are written for the account specified. This option may not be used with the -a, -r, -t or -u options. -t account This option is identical to the -T option except that, in addition, user allocations to the listed accounts are also listed. This option may not be used with the -a, -r, -T or -u options. -u I Information about the users in the list is displayed. This option may not be used with the -r, -T or -t options. EXAMPLES mshare report the status of the calling user's allocations to his/her current account on the resource partition of which the host on which mshare is being executed is a member. mshare -u joan, report the status of user joan's access to all their accounts mshare -a sab report the status of the account sab. mshare -t fll report the status of all child nodes of fll. mshare -T root -0 report the status of all accounts from which some time has been used. Do not report user allocations. mshare -t root -0 report the status of all accounts and user allocations from which some time was used. mshare -r sab report the status of account sab and all of its parents up through the root account. mshare -u joan -a sab report all allocations for user joan and report the status of account sab EXIT CONDITIONS If there is an error, mshare returns an exit status of 1. AUTHOR Written by Philip D. Eckert REPORTING BUGS Report bugs to SEE ALSO (Understanding Job Priority Calculation on Moab Scheduled Machines - UCRL-SM-230043) POD ERRORS Hey! The above document had some coding errors, which are explained below: Around line 625: You forgot a '=back' before '=head1' perl v5.10.1 2015-02-04 MSHARE(1)