display

You can use the command option to view all the available information about item definitions of the same type.

Overview

You can configure the command line syntax with different parameters to view specific results. In this way, you can view the information about one or all item definitions of the same type available in the database. The details for each item are displayed as described in the table.
Table 1. Output format for displaying items
items Details
calendar
  • Calendar Name
  • Updated On
  • Locked By
domain
  • Domain Name
  • Parent Domain
  • Master
  • Updated On
  • Locked By
folder
  • Name
  • Updated On
  • Locked By
job definition
  • Workstation
  • Job Definition Name
  • Updated On
  • Locked By
  • Job Definition
job stream
  • Workstation
  • Job Stream Name
  • Valid From
  • Updated On
  • Locked By
  • Job Stream Definition
prompt
  • Prompt Name
  • Updated On
  • Locked By
  • Prompt Definition
resource
  • Workstation
  • Resource Name
  • Quantity
  • Updated On
  • Locked By
run cycle group
  • Run Cycle Group Name
  • Updated On
  • Locked By
user
  • Workstation
  • Username
  • Updated On
  • Locked By
variable
  • Variable Table Name
  • Variable Name
  • Updated On
  • Locked By
variable table
  • Variable Table Name
  • Default
  • Updated On
  • Locked By
  • Members
workstation
  • Workstation Name
  • Type
  • Ignored
  • Updated On
  • Locked By
  • Workstation Definition
workstation class
  • Workstation Name
  • Type
  • Domain
  • Ignored
  • Updated On
  • Locked By

Syntax and command line options

You must provide at least one scheduling with the command to perform the action. 
ocli model display | di Scheduling item
For the list of scheduling parameters that you can use and the format that needs to be followed, see the tables below.
Scheduling items
Table 2. Scheduling items
Scheduling items Description
calendars | calendar | cal [folder/]calname You can specify the [folder/]calname and optionally, the folder in which the calendar is defined. If you do not specify the [folder/]calname, all the calendar definitions in the database are displayed in order.
domain | dom domainname You can specify the domainname. If you do not provide the domainname, all the domain definitions in the database are displayed. Wildcard characters are permitted.
folder | fol foldername You can specify the name of the folder. If you do not provide the foldername, all the folder definitions are displayed. 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 @. 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.
parms | parm | variable | vb [[folder/]tablename.]variablename You must provide the [[folder/]tablename.]variablename to display 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.
prompt | pr [folder/]promptname You can specify the [folder/]promptname. If you do not specify a [folder/]promptname, all the prompt definitions in the database are displayed. Wildcard characters are permitted.
resource | re | reso [folder/]resourcename You can specify the [folder/]resourcename. You can provide the [folder/]workstationame#] and the folder in which the resource is defined to make the selection more specific. If you do not provide the [folder/]resourcename, all the resource definitions in the database are displayed. Wildcard characters are permitted.
runcyclegroup | rcg [folder/]rcgname] You can specify the [folder/]rcgname]. If you do not specify a [folder/]rcgname], all the run cycle group definitions in the database are displayed. Wildcard characters are permitted.
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 displayed. 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 displayed. 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 and optionally, you can provide the folder in which the items are located. Wildcard characters are permitted.
workstationclass | wsc [folder/]workstationclassname] You can specify the [folder/]workstationclassname]. If you do not specify a [folder/]workstationclassname], all the workstation class definitions in the database are displayed. Wildcard characters are permitted.
Note:

When you run the display command, the template also displays the unique ID assigned to each item. If you want to view the template without these IDs, you can use the noid parameter along with the command.

For example, 
ocli model -format json display jd @#@ noid

Example

  1. Run the following command to display all calendars:
    ocli model display ws=@
    The sample output is as follows:
     HCL Orchestration Command Line Interface
Licensed Materials – Property of HCL
(c) Copyright HCL Technologies Ltd. 2019, 2024.
Workstation Name Type                Domain           Ignored Updated On Locked By
---------------- ------------------- ---------------- ------- ---------- ---------------
LONDON_1   AGENT               -                        02/27/2024 -

CPUNAME /LONDON_1
  DESCRIPTION "This workstation was automatically created."
  OS UNIX
  NODE LONDON
  SECUREADDR 35114
  TIMEZONE Europe/Rome
  FOR MAESTRO HOST EU-HWS-LNX12_DWB
    AGENTID "C55040CCCA6EM6783A7F930722A5C"
    TYPE AGENT
    SECURITYLEVEL HTTPS
    PROTOCOL https
END