list
You can use the list command to view the list of items of the same type.
Overview
You can configure the command line syntax with different parameters to view the list of items of the same type. You cannot run the command to view the list of different item types at the same time.
| Items | Details |
|---|---|
| access control list |
|
| aiagent |
|
| apikey |
|
| calendar |
|
| event source |
|
| folder |
|
| parms |
|
| resource |
|
| security role |
|
| task definition |
|
| user |
|
| vartable |
|
| workflow |
|
| workstation |
|
Syntax and command line options
ocli model list | l | li Scheduling or Security item [;showid]You
can use the following scheduling or security parameters to view specific
information.| Scheduling items | Description |
|---|---|
apikey Label |
If you specify the name of the apikey
(Label), the details of that specific
apikey are displayed or else use wildcard characters to display
the details of all the apikeys. Restriction: The service apikeys are not displayed
when you perform this action. |
calendars | calendar | cal
[folder/]calname |
You can specify the name of the calendar and optionally, the folder in which the calendar is defined. Otherwise use wildcard characters to list all the calendar definitions. |
eso | eventsource | so
[folder/]eventsourcename
|
You can specify the name of the event source and optionally, the folder in which the event source is defined. Otherwise use wildcard characters to display all the event source definitions. |
folder | fol
foldername |
You can specify the name of the folder. Otherwise use wildcard characters to display all the folder definitions. |
jobs | jobdefinition | jd
[[folder/]workstationame#][folder/]jobname
|
If you provide a specific jobname only that particular task definition is displayed. You can provide [folder/]workstationame#] and the folder in which the task is defined to make the selection more specific. Otherwise use wildcard characters to list all the task definitions. |
jobstream | js | sched
[[folder/]workstationame#][folder/]jstreamname[valid
from date|valid to date|valid in
date][;full] |
If you provide a specific jstreamname
only that particular workflow definition is displayed. You can provide
[folder/]workstationame#] and the folder
in which the workflow is defined to make the selection more specific. Otherwise use
wildcard characters to list all the workflow definitions. You can also add the options below to provide
more details of the workflow. valid from date: You can specify a date which will restrict the selection of workflows, that have a valid from date equal to the value specified. The format is mm/dd/yyyy. valid to date: You can specify a date which will restrict the selection of workflows, that have a valid to date equal to the value specified. The format is mm/dd/yyyy. valid in
date: Specify the time frame at which the
task is run. You can specify one of the dates as
full: If you add the option, all the task definitions in the workflow are displayed. |
parms | parm | variable | vb
[[folder/]tablename.]variablename |
You must provide the [[folder/]tablename.]variablename to view a specific variable within a specific table. If you specify the variablename only, the variable definition in the default variable is displayed. Otherwise use wildcard characters to display all the global variable definitions in the default variable table. Wildcard characters are permitted on both [folder/]tablename and variablename. |
resource | res
[[/workstationfolder/workstationname#/foldername/resourcename]
| [workstationname#/foldername/resourcename] |
[/foldername/resourcename] |
resourcename] |
Enter the resource key to list a specific definition or use wildcard characters to list all the resource definitions at the same time. If the resource is defined in the root folder, specify only the name of the resource. Otherwise add the resource key that contains the workstation name and folder name. |
user | credential | cred
[[folder/]workstationame#]username
[;password] |
You can provide [folder/]workstationame#] and the folder in which the user is defined, to make the selection more specific. Otherwise use wildcard characters to list all the user definitions. |
vartable | vt
[folder/]tablename |
You can specify the name of the variable table and optionally, you can provide the folder in which the variable table is defined. If you do not specify the tablename and add wildcard characters, all the variable table definitions are copied into the file. |
workstation | ws | cpu
[folder/]workstationame] |
You can specify the name of the workstation that you want to view. Optionally, you can provide the folder in which the items are located. Otherwise use wildcard characters to list all the workstation definitions. |
| Security items | Description |
|---|---|
accesscontrollist | acl
foldername|F+foldername|A+ADMIN |
If you specify the
foldername|F+foldername|A+ADMIN, the
access control list definition for that particular folder is
displayed and if not, the access control list definitions for
all the folders are displayed. Otherwise use wildcard characters
to list all the access control list definitions. foldername|F+foldername: You can specify the option if you want to filter out the lists that are associated with a folder. The security roles are valid, only for the items available in the folder. A+ADMIN: You can specify this option, if you want to filter out the lists that allows specific permissions on API keys (that are not defined in folders) and on agent registration action. |
securityrole | srol
securityrolename |
If you specify the securityrolename, the security role definition for that particular security role is displayed. Otherwise use wildcard characters to list all the security role definitions. |
| Item | Description |
|---|---|
aiagent
aiagent_name |
If you specify the aiagent_name, the details for that particular AI agent is displayed. If you do not provide any value, details of all the AI agents in the database are displayed. |
You can specify the parameter with the item workstation and the unique identifier for the item is displayed in the results.
Examples
- Run the following command to list all
calendars:
ocli model list calendars @ - Run the following command to list workstation
kottayam, stored in folderkerala:ocli model list ws kerala/kottayam