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.

You must have the list access for the item to perform the action.
Table 1. Output format for displaying items
items Details
calendar
  • Calendar name
  • Updated On
  • Locked By
folder
  • Name
  • Updated On
  • Locked By
parms
  • Variable Table Name
  • Variable Name
  • Updated On
  • Locked By
vartable
  • Variable Table Name
  • Default
  • Updated On
  • Locked By
job definition
  • Workstation
  • Job Definition Name
  • Updated On
  • Locked By
job stream
  • Workstation
  • Job Stream Name
  • Valid From
  • Updated On
  • Locked By
event source
  • Event source name
  • Updated On
  • Locked By
user
  • Username
  • Workstation
  • Updated On
  • Locked By
workstation
  • Workstation Name
  • Type
  • Domain
  • Ignored
  • Updated On
  • Locked By
access control list
  • Name
  • Updated On
  • Locked By
apikey
  • User ID
  • Label
  • Last Usage
  • Expiration
  • Updated On
  • Locked by
security role
  • Name
  • Updated On
  • Locked By

Syntax and command line options

You must provide at least one scheduling or security item with the command to perform the action. The ;showid parameter is optional.
ocli model list | l | li Scheduling or Security item [;showid]
You can use the following scheduling or security parameters to view specific information.
Note: The showid parameter is only allowed for workstations, job streams, jobs, calendars and security roles.
Table 2. Scheduling items
Scheduling items Description
apikey Label If you specify the name of the apikey (Label), the details of that specific apikey are displayed or else the details of all the apikeys are displayed.
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. If you do not specify the calname, all the calendar definitions in the database are listed in order.
folder | fol foldername You can specify the name of the folder. If you do not provide the foldername, all the folder definitions in the database are displayed. Wildcard characters are permitted.
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. If you do not provide the [[folder/]tablename.]variablename, all the global variable definitions in the default variable table are displayed. Wildcard characters are permitted on both [folder/]tablename and variablename.
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. Wildcard characters are permitted.
jobs | jobdefinition | jd [[folder/]workstationame#][folder/]jobname If you provide a specific jobname only that particular job definition is displayed and if not, all the job definitions are displayed. You can provide [folder/]workstationame#] and the folder in which the job is defined to make the selection more specific. Wildcard characters are permitted.
sched | jobstream | js [[folder/]workstationame#][folder/]jstreamname[valid from date|valid to date|valid in date][;full] If you provide a specific jstreamname only that particular job stream definition is displayed and if not, all the job stream definitions are displayed. You can provide [folder/]workstationame#] and the folder in which the job stream is defined to make the selection more specific. Wildcard characters are permitted. You can also add the options below to provide more details of the job stream.

valid from date: You can specify a date which will restrict the selection of job streams, 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 job streams, 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 job is run. You can specify one of the dates as @. The format is mm/dd/yyyy-mm/dd/yyyy.

full: If you add the option, all the job definitions in the job stream are displayed.
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. If you do not specify the eventsourcename, all the event source definitions are listed in order. Wildcard characters are permitted.
users | user [[folder/]workstationame#]username [;password] If you do not provide any specific username, all the usernames in the database are listed. You can provide [folder/]workstationame#] and the folder in which the user is defined, to make the selection more specific. Wildcard characters are permitted.
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. Wildcard characters are permitted.
Table 3. Security items
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. Wildcard characters are permitted.

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 and if not, the security role definitions for all the security roles are displayed. Wildcard characters are permitted.
showid

You can specify the parameter with the item workstation and the unique identifier for the item is displayed in the results.

Examples

  1. Run the following command to list all calendars:
    ocli model list calendars @
  2. Run the following command to list workstation kottayam, stored in folder kerala:
    ocli model list ws kerala/kottayam