list

Lists, or prints summary information about objects defined in the HCL Workload Automation database. List provides you with the list of objects names with their attributes. Print sends the list of objects names with their attributes to the device or file specified in the MAESTROLP local variable. The print command can be used to send the output to a local printer, if the MAESTROLP variable is set accordingly.

Authorization

If the enListSecChk global option is set to yes on the master domain manager, then to list or print an object you must have either list access, or list and display access.

To list security objects, you must have permission for the display action on the object type file with attribute name=security.

Syntax

{list | l}
{[calendars | calendar | cal=[folder/]calname] |
[eventrule | erule | er=[folder/]eventrulename] |
folder|fol=foldername |
[parms | parm | vb=[[folder/]tablename.]variablename] |
[vartable | vt=[folder/]tablename] |
[prompts | prom=[folder/]promptname] |
[resources | resource | res=[[folder/]workstationame#]resourcename] |
[runcyclegroup | rcg=[folder/]runcyclegroupname] |
[cpu={[folder/]workstationame | [folder/]workstationclassname | domainame}]
[wat=workloadapplicationtemplatename]
[workstation | ws=[folder/]workstationame] |
[workstationclass | wscl=[folder/]workstationclassname] |
[domain | dom=domainame] |
[jobs | jobdefinition | jd=[[folder/]workstationame#][folder/]jobname] |
[sched |jobstream | js= [[folder/]workstationame#][folder/]jstreamname
   [valid from date|
    valid to date |valid in date date] |
[users | user=[[folder/]workstationame#]username] |
[accesscontrollist | acl for securitydomainname] |
[securitydomain | sdom=securitydomainname] |
[securityrole | srol=securityrolename]}
[;offline]
[;showid]

Arguments

calendars | calendar | cal

If no argument follows, lists or prints all calendar definitions.

If argument [folder/]calname follows, lists or prints the calname calendar. Wildcard characters are permitted.

eventrule | erule | er

If no argument follows, lists or prints all event rule definitions.

If argument [folder/]eventrulename follows, lists or prints the eventrulename event rule. Wildcard characters are permitted.

folder | fol

If no argument follows, lists or prints the current folder.

If argument foldername follows, lists or prints the foldername folders. Wildcard characters are permitted.

You can also use the dedicated listfolder composer command to list folders.

parms | parm | vb

If no argument follows, lists or prints all global variable definitions found in the default variable table.

If argument [folder/]tablename.variablename follows, lists or prints the variablename variable of the tablename table. If tablename is omitted, composer looks for the variable definition in the default variable table. Wildcard characters can be used on both tablename and variablename. For example:

list parms=@.@

Lists all variables on all tables.

list parms=@

Lists all variables on the default table.

list parms=@.acct@

Lists all the variables whose name starts with acct on all the existing tables.

vartable | vt

If no argument follows, lists or prints all variable table definitions.

If argument [folder/]tablename variable table follows, lists or prints the tablename variable table. Wildcard characters are permitted.

prompts | prom

If no argument follows, lists or prints all prompt definitions.

If argument [folder/]promptname follows, lists or prints the promptname prompt. Wildcard characters are permitted.

resources | resource | res

If no argument follows, lists or prints all resource definitions.

If argument [folder/]workstationame#[folder/]resourcename follows, lists or prints the resourcename resource of the workstationame workstation in the specified folder on which the resource is defined. If workstationame is omitted, the default is the workstation on which composer is running. Wildcard characters are permitted.

runcyclegroup | rcg

If no argument follows, lists or prints all run cycle groups.

If argument [folder/]runcyclegroupname follows, lists or prints the runcyclegroupname run cycle group. Wildcard characters are permitted.

[folder/]workstation

The name of the workstation. Wildcard characters are permitted.

[folder/]workstationclass

The name of the workstation class. Wildcard characters are permitted.

domain

The name of the domain. Wildcard characters are permitted.

wat

If no argument follows, lists or prints all workload application template definitions.

If argument [folder/]workloadapplicationtemplate follows, lists or prints the specified workload application template. Wildcard characters are permitted.

workstation | ws

If no argument follows, lists or prints all workstation definitions.

If argument [folder/]workstationname follows, lists or prints the workstationname workstation. Wildcard characters are permitted.

domain | dom

If no argument follows, lists or prints all domain definitions.

If argument domainname follows, lists or prints the domainname domain. Wildcard characters are permitted.

workstationclass | wscl

If no argument follows, lists or prints all workstation class definitions.

If argument [folder/]workstationclassname follows, lists or prints the workstationclassname workstation class. Wildcard characters are permitted.

[folder/]

The folder where the job or job stream definition is stored. You can specify folder names using absolute or relative paths. If you want to submit the command from a precise folder, then you can use the chfolder command to navigate folders and sub-folders. The chfolder command changes the working directory, which is set to root ("/") by default, so that you can use relative folder paths when submitting commands. See chfolder for more information about changing folder paths.

jobs | jobdefinition | jd

If no argument follows, lists or prints all job definitions.

If argument workstationame#[folder/]jobname follows, lists or prints the jobname job stored in the folder named [folder/] of the workstationame workstation on which the job runs. If workstationame is omitted, the default is the workstation on which composer is running. Wildcard characters are permitted for workstationame, [folder/], and jobname.

sched | jobstream | js

If no argument follows, lists or prints all job stream definitions.

If argument workstationame#[folder/]jstreamname follows, lists or prints the jstreamname job stream stored in the folder named [folder/] of the workstationame workstation on which the job stream is defined. If workstationame is omitted, the default is the workstation on which composer is running. Wildcard characters are permitted for workstationame, [folder/], and jstreamname.

valid from

date Restricts the selection to job streams that have a valid from date equal to the indicated value. The format is mm/dd/yyyy.

valid to

date Restricts the selection to job streams that have a valid to date equal to the indicated value. The format is mm/dd/yyyy.

valid in

date date The time frame during which the job stream can run. The format is mm/dd/yyyy - mm/dd/yyyy. One of the two dates can be represented by @.

users | user

If no argument follows, lists or prints all user definitions.

If argument [folder/]workstationame#username follows, lists or prints the username user of the workstationame workstation in the specified folder on which the user is defined. If workstationame is omitted, the default is the workstation on which composer is running. Wildcard characters are permitted.

Note: If you are listing windows users in the UPN format username@internet_domain , insert the escape character '\' before the '@' character in the username@internet_domain value. For example if you are listing the administrator@bvt.com user, run the following command:

list users=administrator\@bvt.com

accesscontrollist | acl

If no securitydomainname argument follows, lists or prints the access control list definitions for all the security domains.

If argument securitydomainname follows, lists or prints the access control list definitions for the securitydomainname security domain. Wildcard characters are permitted for securitydomainname .

securitydomain | sdom

If no securitydomainname argument follows, lists or prints all the security domain definitions.

If argument securitydomainname follows, lists or prints the securitydomainname security domain definition. Wildcard characters are permitted for securitydomainname .

securityrole | srol

If no securityrolename argument follows, lists or prints all the security role definitions.

If argument securityrolename follows, lists or prints the securityrolename security role definition. Wildcard characters are permitted for securityrolename .

;offline

Sends the output of the command to the composer output device. For information about this device, see UNIX variables. The list ..... ;offline command is equivalent to the print command.

showid

Displays a unique identifier that identifies a workstation, resource or prompt. These objects are no longer identified in the plan solely by their names, but also by the folder in which they are defined. The name and folder association is mapped to a unique identifier. For example, for workstations, the this_cpu option is the unique identifier of the workstation in the localopts file. You can verify the unique identifier for workstations, resources, and prompts by submitting the composer list command, together with the ;showid filter, or by submitting the conman command, showcpus, showresources, or showprompts, in combination with the ;showid filter. See the related example in the Examples section.

Identifying workstations by their unique identifier avoids the problem that occurred in previous versions when objects were renamed in the plan. For example, if an object was renamed and then carried forward to a new production plan, references to the old object name were lost. With the implementation of the unique identifier, this will no longer occur and dependencies will be correctly resolved.

When deleting a workstation, if the workstation is still in the plan, then another workstation cannot be renamed with the name of the deleted workstation for the number of days specified by the global option folderDays. However, a brand new workstation can be created with the name of the deleted workstation. This behavior applies only to dynamic agents, pools, and dynamic pools. The default value is 10 days.

When deleting a folder, a prompt, or resource, if there are still objects in the plan that reference these objects, then another folder, prompt, or resource cannot be renamed with the name of the deleted folder, prompt or resource for the number of days specified by folderDays. However, a brand new folder, prompt, or resource can be created with the name of the deleted object. For more information about the folderDays option see Global options - detailed description.

Results

List provides you with the list of objects names with their attributes. Print sends the list of objects names with their attributes to the device or file set in the MAESTROLP local variable. The print command can be used to send the output to a local printer, if you set the MAESTROLP variable accordingly. Make sure the MAESTROLP is set in your environment before running the print command.

Depending on the value set in the MAESTROCOLUMNS local variable the different sets of information about the selected object can be shown.

See Offline output for more information on how to set MAESTROLP.

See also

From the Dynamic Workload Console you can perform the same tasks as described in:

the Dynamic Workload Console User's Guide.

• To list or print workstations, see

  Designing your scheduling environment.

• To list or print event rules, see

  Editing event rules.

• To list or print access control lists, security domains, and security roles, see

  Managing Workload Security.

• To list or print all other objects, see

  Listing object definitions in the database.