modify

You can use the modify command to update the existing scheduling or security items in the database.

Overview

The command option performs similar to new command, when you want to modify an item that is not available in the database. When you run the command, the selected item definition is copied and opened in a temporary file. You can then edit the file and replace the existing item.

Syntax and command line options

You must provide at least one scheduling or security item with the command to perform the action.
ocli model modify|m Scheduling or Security item
Important: If you modify an item by changing its key, a new item is created without modifying the existing one. You can use the rename command to modify the item.
For the list of scheduling or security items that you can use and the required format, see the following tables.
Table 1. Scheduling items
Scheduling items Description
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 displayed in a file for editing.
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 in a file for editing. Wildcard characters are permitted.
jobs | jobdefinition | jd [[folder/]workstationame#][folder/]jobname If you provide a specific jobname only that particular job definition is displayed for editing 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 for editing 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 for editing.

parms | parm | variable | vb [[folder/]tablename.]variablename You must provide the [[folder/]tablename.]variablename to update 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 for editing. Wildcard characters are permitted on both [folder/]tablename and variablename.
users | user [[folder/]workstationame#]username [;password] If you do not provide any specific username, all the usernames in the database are displayed for editing. You can provide [folder/]workstationame#] and the folder in which the user is defined, to make the selection more specific. Wildcard characters are permitted.
vartable | vt [folder/]tablename You can specify the name of the variable table and optionally, you can specify 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 a temporary file and opened for editing.
workstation | ws | cpu [folder/]workstationame] You can specify the name of the workstation that you want to update. Optionally, you can provide the folder in which the items are located. If you do not specify the workstationame, all the calendar definitions in the database are displayed in a file for editing. Wildcard characters are permitted.
Table 2. 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 for editing 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 for editing and if not, the security role definitions for all the security roles are displayed. Wildcard characters are permitted.

Examples

  1. Run the following command to edit all the calendar definitions:
    ocli model modify cal @
  2. Run the following command to modify the job stream FINAL located at folder TEAMS that is launched on workstation WS1:
    ocli model modify sched WS1#TEAMS/FINAL