vovfsgroup

vovfsgroup: Usage Message

    DESCRIPTION:
    Create, show, and modify attributes of FairShare Groups.
    The script also controls Access Control Lists (ACL) for
    FairShare groups. See information on ACL for additional detail.

    SYNOPSIS:
    % vovfsgroup <action> <group> ...

    WHERE:
    <action>      is one of "acl, aclrec, create, exists, delete, genconfig,
                             loadconfig, modify, modrec, normalize, show"
    and is case-insensitive
    <group>       is the name of the FairShare group

    USAGE:
    vovfsgroup acl <group> GET
                  // Retrieve FairShare Group ACLs
    vovfsgroup acl <group> RESET
                  // Reset FairShare Group ACLs to Default
    vovfsgroup acl <group> APPEND OWNER "Privilege List"
                  // Append Privs to FairShare Group
    vovfsgroup acl <group> APPEND EVERYBODY "Privilege List"
                  // Append Privs to FairShare Group
    vovfsgroup acl <group> APPEND USER <user> "Privilege List"
                  // Append Privs to FairShare Group

    Same as above, but apply setting recursively
    to all nodes in the FairShare group:
    vovfsgroup aclrec <group> GET
                  // Retrieve FairShare Group ACLs
    vovfsgroup aclrec <group> RESET
                  // Reset FairShare Group ACLs to Default
    vovfsgroup aclrec <group> APPEND OWNER "Privilege List"
                  // Append Privs to FairShare Group
    vovfsgroup aclrec <group> APPEND EVERYBODY "Privilege List"
                  // Append Privs to FairShare Group
    vovfsgroup aclrec <group> APPEND USER <user> "Privilege List"
                  // Append Privs to FairShare Group

    vovfsgroup create <group>
                  // Create a new FairShare group

    If the owner-user of the product instance is performing the clone:
      vovfsgroup clone -take <group> <new group>
                  // Clone an existing group and all subgroups to a new group,
                  //   with the current user taking ownership of the new group
                  //   and all subgroups
      vovfsgroup clone -preserve <group> <new group>
                  // Clone an existing group and all subgroups to a new group,
                  //   with ownership of the new group and all subgroups
                  //   copied from the original group
    If any other user is performing the clone:
      vovfsgroup clone <group> <new group>
                  // Clone an existing group and all subgroups to a new group,
                  //   with the current user taking ownership of the new group
                  //   and all subgroups

    NOTE: the owner-user of the product instance MUST specify either -take
          or -preserve with the clone command.  Users other than the
          owner-user cannot use the -preserve argument.  Only subgroups to
          which the user has access will be cloned.

    vovfsgroup exists <group>
                  // Exit status = 0 if group exists
    vovfsgroup delete <group>
                  // Delete a FairShare group
    vovfsgroup delete -unused
                  // Remove unutilized FairShare groups

    vovfsgroup modify <group> weight <integer-value>
                  // Change the weight of a FairShare group
    vovfsgroup modify <group> window <time-spec>
                  // Change the window size of a FairShare group
    vovfsgroup modify <group> owner  <owner-name>
                  // Change owner (requires SERVER status)
    vovfsgroup modify <group> flatten <0|1>
                  // Changed the flattened/non-flattened state of the group
                  //  (0 by default). If a group is flattened, its target
                  //  share is calculated differently; instead of the usual
                  //  hierarchical weighting, all non-leaf node weights are
                  //  ignored and leaf nodes are weighted against each other
                  //  as though they were all part of the same level of
                  //  hierarchy.  Note that vovfsgroup modrec should not be
                  //  used with flatten; it will work but is inefficient,
                  //  as vovfsgroup modify will already propagate the flag
                  //  to any child groups.


    Same as above, but apply setting recursively
    to all nodes in the FairShare group:
    vovfsgroup modrec <group> weight <integer-value>
                  // Change the weight of a FairShare group.
    vovfsgroup modrec <group> window <time-spec>
                  // Change the window size of a FairShare group.
    vovfsgroup modrec <group> owner  <owner-name>
                  // Change owner (requires SERVER status).
    vovfsgroup genconfig <NEW_CONFIG_FILE>
                  // Generate config file (name specified)

    EXAMPLES:
    % vovfsgroup help
    % vovfsgroup create /class/sim
    % vovfsgroup modify /time/users weight 121
    % vovfsgroup modify /time/users window 8h
    % vovfsgroup modify /time/users owner  mary
    % vovfsgroup modify /time/users flatten 1
    % vovfsgroup modrec /time/users window 8h
    % vovfsgroup exists /time
    % vovfsgroup show
    % vovfsgroup show   /time/users
    % vovfsgroup delete /class/sim /class/verilog
    % vovfsgroup delete -unused
    % vovfsgroup acl    /class/sim  GET
    % vovfsgroup acl    /class/sim  RESET
    % vovfsgroup acl    /class/sim  APPEND EVERYBODY "ATTACH VIEW"
    % vovfsgroup acl    /class/sim  APPEND USER jong "ATTACH VIEW"
    % vovfsgroup acl    /class/sim  APPEND USER jong "ATTACH VIEW"
    % vovfsgroup acl    /           SET    OWNER "ALL"
    % vovfsgroup normalize /time/projects 1000
    % vovfsgroup genconfig
    % vovfsgroup genconfig -leaf MyGroupsIncludingLeafNodes.tcl
    %
    % vovfsgroup genconfig myconfig.tcl
    % vovfsgroup loadconfig myconfig.tcl
    %
    % vovfsgroup genconfig -serial myconfig.txt
    % vovfsgroup loadconfig myconfig.txt