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 |
---|---|
calendar |
|
folder |
|
parms |
|
vartable |
|
job definition |
|
job stream |
|
user |
|
workstation |
|
access control list |
|
apikey |
|
security role |
|
Syntax and command line options
ocli model list| li | l Scheduling or Security item [;showid]
For the list of scheduling or security items that you can use and the required
format, see the following tables. 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
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 date: Specify the time frame at which the
job is run. You can specify one of the dates as
full: If you add the option, all the job definitions in the job stream are displayed. |
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. |
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. |
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