Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Universal Controller supports the following CLI functions for Resources, which are listed alphabetically on this page.

Syntax, parameters, and examples for each function are provided.

Anchor
ops-resource-limit
ops-resource-limit

List Virtual Resources

Description

Lists all specified virtual resources.

Syntax

uagcmd ops-resource-list global parameters [resource-name=name] [resource-type=type] [options=v]

Parameters

  • resource-name=
    Opitonal; Name of virtual resource(s) to be listed. Wildcards are supported.
  • resource-type=
    Optional; One of the following (not case sensitive): renewable, boundary, depletable. (If not specified, all types of virtual resources are listed.)
  • options=
    Optional; Supports the v (verbose) option, which will toggle the SysId and Used By columns in the response output.

Example


Panel
uagcmd ops-resource-list -c config.cfg resource-name=Resource A


...

Note
titleNote

The CLI command response will contain the following information for each matching virtual resource:

  • Name - Virtual Resource name
  • Type - Virtual Resource type
  • Limit - Virtual Resource limit
  • Used - Amount of the virtual resource currently used; applicable only to renewable virtual resources
  • SysId - Virtual Resource sys_id
  • Used By - Task instances currently using the Virtual Resource in the format {(task-instance-name:resource-amount),(task-instance-name:resource-amount),...}

Anchor
ops-update-resource-limit
ops-update-resource-limit

Update Resource Limit

Description

Updates the resource limit for a resource.

Syntax

Anchor
ops-update-resource-limit
ops-update-resource-limit
uagcmd ops-update-resource-limit global parameters resource-name=name resource-limit=limit
 

Note
titleNote

For backward-compatibility, you can exclude uagcmd from the command line for this function and all pre-6.2.0.0 CLI functions.


Parameters

  • resource-name=
    Required; Name of resource to update the limit on.
  • resource-limit=
    Required; Resource limit (any integer >= 0).

Example


Panel
uagcmd ops-update-resource-limit -c config.cfg resource-name=Resource A resource-limit=5


...