CLASS Console

Consoles are the connections ConsoleWorks has to assets. This component class enables adding, deleting, or retrieving consoles. This class requires no license. It uses standard functions, actions, and associations to perform Console related operations.

Class Field Properties

Name Codename Description Ability Length
curpriv CurrentPrivs Current Privileges RO 255
created Created Created RO 255
created_by CreatedBy Created By RO 255
updated Updated Updated RO 255
updated_by UpdatedBy Updated By RO 255
exampver ExampleVersion Example Version RO 255
exampoutofdate ExampleOutOfDate Example Out Of Date RO 255
status Status Status Icon RO 255
statustext StatusText Status RO 255
color Color Status Color RO 255
eventlast LastEvent Last Event RO 255
eventworst WorstEvent Worst Event RO 255
eventact ActiveEvents Active Events RO 255
eventack AcknowledgedEvents Acknowledged Events RO 255
password Password Password WO 255
password2 Password2 Secondary Password WO 255
defwriterkey DefWriterKey Default Logger Key RO 255
lastclear LastClear WR 255
altlogging AltLogging Alt Log Active RO 255
lockdown Locked Locked RO 255
lockaddr LockAddr Lock Address RO 255
lockreason LockReason Lock Reason RO 255
ioqdumped IOQDumped IOQ Dumped RO 255

Class Functions

Name Description
static add Console.add(name) takes an argument, console name. The console name can be explicit or checked for existence then retrieved with Console.getNames(). User must have create privileges. Console.add() deletes a named console.
static AnnotateLog AnnotateLog() takes no arguments. User must have view log and modify log privileges. This action allows the User to annotate the log of an object..
static cancel cancel() takes no arguments. User must have cancel privileges. This standard function removes any pending edits on the object. Used with Console.get(name).
static close Console.close() takes no arguments.
static CmdCtrlConnect Console.CmdCtrlConnect() takes no arguments. User must have command control connect privileges. Console.CmdCtrlConnect() starts a controlled-only terminal connection to a console when used with Console.connect().
static connect Console.connect() takes no arguments.
static Connect Console.connect() takes no arguments. Users must have connect privileges. This action enables the connection from a CmdCtrolConnect object.
static create Console.create() takes no arguments.
static delete Console.delete() takes 3 arguments.
static Disable Console.Disable(comment) takes an argument, comment (max 255 characters). User must have disable privileges. The console name can be explicit or checked for existence then retrieved with Console.getNames().
static DisableAll Console.DisableAll(comment) takes an argument, comment (max 255 characters). User must have disable all privileges. Disables all consoles.
static DisableScanning Console.DisableScanning() takes no arguments. User must have disable scan privileges. Console.DisableScanning() disables a named object. Used with Console.get(name).
static DisableScanningAll Console.DisableScanningAll() takes no arguments. User must have disable scan privileges. Console.DisableScanningAll() disables a named object. Used with Console.get(name).
static Display Console.Display() takes no arguments. Console.Display() action displays a hidden object. User must have display privileges. Used with Console.get(name).
static DisplayAll Console.DisplayAll() takes no arguments. Console.DisplayAll() action displays all hidden consoles. User must have display privileges. Used with Console.get(name).
static DownloadLog Console.DownloadLog() takes no arguments. Console.DownloadLog() action downloads a log file for a target console. User must have view log privileges.
static Enable Console.Enable() takes no arguments. Console.Enable() action enables all consoles. User must have enable privileges.
static EnableAll Console.EnableAll() takes no arguments. Console.EnableAll() action enables all consoles. User must have enable privileges.
static EnableScanning Console.EnableScanning() takes no arguments. Console.EnableScanning() action enables scanning for a target object. User must have enable scan privileges. Used with Console.get(name).
static EnableScanningAll Console.EnableScanningAll() takes no arguments. Console.EnableScanningAll() action enables scanning for all consoles. User must have disable scan all privileges.
static ExclusiveConnect Console.ExclusiveConnect() takes no arguments. Console.ExclusiveConnect() action allows an exclusive connection to a object. User must have esclusive connect privileges. Used with Console.get(name).
static exists Console.exists() takes no arguments.
static get Console.get(name) takes an argument, name. This standard function gets and returns the named object. If the object name exists, it returns the object name. If the object name does not exist, it throws an exception.
static GetConnectionRules Console.GetConnectionRules() takes 1 argument.
static getCount Console.getCount() takes no arguments. This standard function gets the number of defined console resources.
static getFetchLevel Console.getFetchLevel() takes no arguments.
static getList Console.getList() takes no arguments. This standard function gets and returns an array (list) of console objects.
static getLog Console.getLog() takes no arguments.
static getLogCalendar Console.getLogCalendar() takes no arguments.
static getNames Console.getNames() takes no arguments. This standard fucntion gets and returns an array of strings object with the console names.
static getRange Console.getRange() takes no arguments.
static getUsage Console.getUsage() takes no arguments.
static Hide Console.Hide() takes no arguments. Console.Hide() action hides a console. User must have hide privileges. Used with Console.get(name).
static HideAll Console.HideAll() takes no arguments. Console.HideAll() action hides all consoles. User must have hide privileges.
static isConnected Console.isConnected() takes no arguments.
static isNew isNew() takes no arguments and returns a boolean value. This standard function checks for object existence, to create or update when save is called. The function returns true if the object does not exist on the server and will create one when save() is called. It returns false if the object exists and will update the object when save() is called.
static log Console.log() takes no arguments.
static LogComment Console.LogComment(comment,context) takes arguments, comment (max 255 characters. type utf8) and context (max 31 characters. type ascii). User must have log comment privileges. Console.LogComment(comment,context) action writes a comment in the target log file.
static logScannable Console.logScannable() takes no arguments.
static monitor Console.monitor() takes no arguments.
static Monitor Console.monitor() takes no arguments. Console.monitor() starts a monitor-only terminal connection to a console when used with Console.connect().
static read Console.read() takes no arguments.
static refresh Console.refresh() takes no arguments.
static Rename Console.Rename(newname,renamelogs) takes arguments, new name and rename logs (max 127 characters). Console.Rename() action renames a console and the appropriate logs. User must have rename privileges. Used with Console.get(name).
static save save() takes no arguments. User must have save privileges. This standard function saves to the server a object and the appropriate logs. This includes any pending edits made on the object. save() throws an exception if validation or save fails.
static SendCommand Console.SendCommand() takes no arguments, Console.SendCommand() action sends a console command. User must have send command privileges.
static SendFile Console.SendFile() takes no arguments. Console.SendFile() action sends a file from the console. User must have send file privileges.
static SendSimple Console.SendSimple() takes 2 arguments.
static setFetchLevel Console.setFetchLevel() takes no arguments.
static setLock Console.setlock(lockdown,lockreason) takes arguments, 'lockdown' and lock reason (max 127 characters). Console is locked when lockdown='Lock.' Console.setlock() action locks a object. User must have lock privileges. Used with Console.get(name).
static triggerEvent Console.triggerEvent(eventname,evtcontext) takes arguments, event name and event context (max 6144 characters). Console.triggerEvent() triggers an action upon an event occurrence. User must have trigger privileges.
static update Console.update() takes no arguments.
static write Console.write() takes no arguments.

Class Privilege Properties

Type Name
AWARE Aware
CREATE Add
DELETE Delete
VIEW View
MODIFY Edit
LOCK Lock Console
VIEWEVTOCC View Event Occurrence
EDITEVTOCC Edit Event Occurrence
ACK Acknowledge
PURGE Purge
EXPUNGE Expunge
REMEDIATE Remediate
TRIGGER Trigger Event
BCMUPD Update Baseline Run
BCMVIEW View Baseline Run
USAGE View Usage
DISCO Disconnect
RENAME Rename
DISABLE Disable
ENABLE Enable
DISABLEALL Disable All
ENABLEALL Enable All
HIDE Hide
DISPLAY Display Hidden
HIDEALL Hide All
DISPLAYALL Display All Hidden
DISABLESCAN Disable Scan
ENABLESCAN Enable Scan
DISABLESCANALL Disable Scan All
ENABLESCANALL Enable Scan All
ANNOUPD Modify Log Annotation
VIEWLOG View Log
VIEWMONEVT View Monitored Events
LOGCOMMENT Make Comment in Log
SENDCOMMAND Send Command
SENDFILE Send File
SENDPROTECTED Send protected characters
SENDBREAK Can send break
CONNECT Connect
MONITOR Monitor
EXCLUSIVECONNECT Exclusive Connect
CMDCTRLCONNECT Controlled Connect

Class Association Properties

Type Name
tag Console to Tag
scan Console to Scan
actionnew Console to ActionNew
actionack Console to ActionAck
actionpur Console to ActionPurge
bindaddr Console to BindAddr
logtransform Console to LogTransform

Class Multi-Association Properties

Name Description
ConsoleToBaselineToSchedule Console to Baseline to Schedule