gchfund
Synopsis
gchfund { { [-n <fund_name>] [--priority <fund_priority>] [--default-deposit<deposit_amount>] [-d <description>] [-X, --extension <property>=<value>]... [--add-constraint <constraint_name>=[!]<constraint_value>,...]... [--del-constraint(s) <constraint_name>[=<constraint_value>],...]... [--parent <parent_fund_id>] } | { --reset [--all]} } [-u <user_name>] [-g <group_name>] [-a <account_name>] [-o <organization_name>] [-c <class_name>] [-m <machine_name>] [--filter <filter_name>=<filter_value>]... [--filter-type <filter_type>] [--debug] [--site <site_name>] [--help] [--man] [--quiet] [--verbose] [--version] [[-f] <fund_id>]
Overview
gchfund modifies a fund. This includes adding to or deleting from constraints for the account. After applying all filter options, if there is exactly one applicable fund, that fund will be modified. Otherwise, a list of funds will be displayed for the specified filters and you will be prompted to rerun gchfund against one of the enumerated funds.
Options
| -a |
| Format |
-a <account_name>
|
| Default |
--- |
| Description |
Specifies that the fund to modify should be restricted to one usable by the given account. |
| -c |
| Format |
-c <class_name>
|
| Default |
--- |
| Description |
Specifies that the fund to modify should be restricted to one usable by the given class. |
| -d |
| Format |
-d <description>
|
| Default |
--- |
| Description |
Specifies a new description |
| -f |
| Format |
[-f] <fund_id>
|
| Default |
--- |
| Description |
Specifies the ID of the fund to modify. |
| -g |
| Format |
-g <group_name>
|
| Default |
--- |
| Description |
Specifies that the fund to modify should be restricted to one usable by the
given group. |
| -m |
| Format |
-m <machine_name>
|
| Default |
--- |
| Description |
Specifies that the fund to modify should be restricted to one usable by the
given machine. |
| -n |
| Format |
-n <fund_name>
|
| Default |
--- |
| Description |
Specifies a new fund name. |
| -o |
| Format |
-o <organization_name>
|
| Default |
--- |
| Description |
Specifies that the fund to modify should be restricted to one usable by the
given organization. |
| -u |
| Format |
-u <user_name>
|
| Default |
--- |
| Description |
Specifies that the fund to modify should be restricted to one usable by the
given user. |
| -X, --extension |
| Format |
-X or --extension <property>=<value> |
| Default |
--- |
| Description |
Modifies an extension property. You can specify any number of extra field assignments. |
| --add-constraint |
| Format |
--add-constraint <constraint_name>=[!]<constraint_value>[,<constraint_name>=[!]<constraint_value>...]
|
| Default |
--- |
| Description |
Adds a constraint to the fund. The constraint value may be a perl5
regular expression. You can prepend an exclamation point to the constraint value to express a negation of the constraint. You can pass multiple constraints to the --add-constraint option in a
comma-delimited list or specify multiple --add-constraint options. |
| --all |
| Format |
--all
|
| Default |
--- |
| Description |
Specifies that you want to reset all active allocations for all funds when you use it with the --reset option. |
| --debug |
| Format |
--debug
|
| Default |
--- |
| Description |
Logs debug information to the screen.
|
| --default-deposit |
| Format |
--default-deposit <deposit_amount>
|
| Default |
--- |
| Description |
Specifies the default amount for any deposit that is made to this
fund that does not specify a deposit amount. |
| --del-constraint |
| Format |
--del-constraint <constraint_name>=<constraint_value>[,<constraint_name>[=<constraint_value>]...]
|
| Default |
--- |
| Description |
Removes a constraint from the fund. You can pass multiple constraints to the --del-constraint option in a comma-delimited list or by specifying multiple --del-constraint options. |
| --filter |
| Format |
--filter <filter_name>=<filter_value>
|
| Default |
--- |
| Description |
Restricts the fund to one without constraints that conflict with
the specified filters. For example, gchfund --filter User=amy will restrict the fund to one usable by the user amy. You can specify multiple filter
options by logically ANDing them together. |
| --filter-type |
| Format |
--filter-type <filter_type>
|
| Default |
NonExclusive
|
| Description |
Selects the filtering type. If you use the exclusive filter type,
a fund will only be matched if the specified filters meet all
constraints. If you use the non-exclusive filter type, a fund will
be matched as long as the specified filters do not conflict with the constraints. |
| --help |
| Format |
--help
|
| Default |
--- |
| Description |
Displays a brief help message.
|
| --man |
| Format |
--man
|
| Default |
--- |
| Description |
Displays full documentation.
|
| --parent |
| Format |
--parent <parent_fund_id>
|
| Default |
--- |
| Description |
Sets a new parent fund, replacing the current parent fund if one exists. |
| --priority |
| Format |
--priority <fund_priority>
|
| Default |
--- |
| Description |
Sets a new fund priority. |
| --quiet |
| Format |
--quiet
|
| Default |
--- |
| Description |
Suppresses headers and success messages.
|
| --reset |
| Format |
--reset
|
| Default |
--- |
| Description |
Ends all active allocations and initiates a new default deposit. If the default deposit amount is positive, MAM creates a new allocation with this amount, otherwise no deposit is made and the fund becomes inactive. You may reset the allocations for a
specified fund using the [-f] fund_id option, all funds using the --all option, or use filtering options to filter the funds to be reset. Do not use this option with any other modifying option. |
| --site |
| Format |
--site <site_name>
|
| Default |
--- |
| Description |
Obtains a response from specified site. |
| --verbose |
| Format |
--verbose
|
| Default |
--- |
| Description |
Displays modified object details.
|
| --version |
| Format |
--version
|
| Default |
--- |
| Description |
Displays the product version.
|
Related topics