Console Automation services data models

name

String

NA

NA

• A through Z
• a through z
• 0 through 9
• Dash and underscore

Name of the server

The value for creating the name is taken from the URL path and not from the body content.

requireClientCerts

Boolean

false

No

true or false

Client certificates are required

startupHost

String

localhost

No

Valid host name

Startup host when in clustered mode

startupMode

String

Manual

No

manual, disabled, automatic

Specifies one of the following values:

• automatic
• manual
• disabled

viewerPort

Integer

Calculated

No

1—65535

TCP/IP port number on which the server listens for standard viewer connections

html5ViewerPort

Integer

Calculated

No

Not writeable

Listening port number for the HTML5 viewer

watchdogStartupScript

String

Empty

No

RDL function with parameters

Startup script for watchdog

messageCacheSize

Integer

100000

No

Minimum = 10000

Maximum = 2000000

Number of messages for all sessions that the server maintains in its backlog

If you increase this value, you also have to increase the jvmHeapSize value.

jvmHeapSize

Integer

416

No

Value in megabytes

Minimum = 256

No maximum

Maximum heap size in megabytes

The default heap size is based on a messageCacheSize of 100,000 messages and has to be increased if you increase the message cache size.

description

String

Empty

No

String < 256 characters

Longer description for the server to help you identify all the consoles or other sessions that are in it.

userCreated

String

Read-only

User who created this server

This is read-only and is updated automatically. 

dateCreated

Date

Read-only

Date when the server was originally created

This value is read-only and is automatically updated when the server is created.

dateUpdated

Date

Read-only

Date on which the server was last updated

This value is read-only and is automatically updated when the server is updated.

additionalInformation

String

Read-only

Additional information to be displayed for status

For example, Started at boot time.

sessions

Array of session objects

Empty

No

Array of session objects

The exact contents of the object vary based on the session type. For more information, see the Common session properties and the session property descriptions.

sessionType

String

Yes

One of the following:

• ccs
• hmc
• snmp
• syslog
• baroc

Determines which subtypes are to be used.

name

String

NA

NA

• A through Z
• a through z
• 0 through 9
• Dash and underscore

Name is taken from the URL path when a session is created.

enabled

Boolean

True

No

Whether the session is enabled:

• True if the session is enabled
• False if the session is disabled

startupScript

String

Empty

No

RDL function with parameters

RDL startup script to be run when the session is started

viewers

Array of string

Empty

No

Array of strings containing the viewer names to which this viewer is assigned

bkSession

String

No

Backup session to be used when the connection to CCS fails

bomPattern

String

Regex

^......[0-9][0-9]\.[0-9][0-9]\.[0-9][0-9].*

No

NA

charset

String

ISO-8859-1

NA

consoleDomain

String

No

NA

consoleHost

String

Yes

NA

consolePassword

String

Yes

NA

consolePort

Integer

*

NA

consoleSessionName

String

Yes

NA

consoleSessionType

String

CCS

NA

consoleSslPort

Integer

*

Either consoleSslPort or consolePort is required (depending on the consoleUseSsl value)

consoleStartmode

Integer

9

No

NA

consoleType

Integer

1

No

NA

consoleUseSsl

Boolean

Yes

NA

consoleUsername

String

Yes

NA

eventheaderGroups

String

TIME,SYSTEM,JOB,MSGID,ROM

NA

eventheaderRegex

String

Regex

^......(\d\d\.\d\d\.\d\d) +([^ ]+) {1,8}?(........)[ *]+([^ ]+)(.*)

NA

healthcheckAction

String

No

NA

healthcheckCommand

String

No

NA

healthcheckEnable

Boolean

False

No

NA

healthcheckTimeout

Integer

60

No

NA

leftMargin

Integer

6

No

NA

screenWidth

Integer

80

No

NA

scrollBottom

Integer

20

No

NA

scrollTop

Integer

0

No

NA

systemDevice

String

NA

systemName

String

CCS server name

useDefaults

Boolean

True

No

NA

wtorheaderGroups

String

TIME,SYSTEM,JOB,REPLYNUM,MSGID,ROM

No

NA

wtorheaderRegex

String

Regex

^......(\d\d\.\d\d\.\d\d) +([^ ]+) {1,8}?(........) \*([0-9]+)[ *]+([^ ]+)(.*)

No

NA

zvmCpRead

String

CP READ

No

Actual text of the status indicator on the last line for the CP Read mode.

The default is CP READ.

zvmHolding

String

HOLDING

No

Actual status indicator text on the last line for the Holding mode.

The default is HOLDING.

zvmHost

0

No

NA

zvmMore

String

MORE

No

Actual status indicator text on the last line for the More mode.

zvmPagerEnabled

Boolean

False

No

Enables the z/VM automatic pager

When the console status on the last line is MORE or HOLDING, BMC AMI Console Automation will automatically clear the screen.

zvmPagerTimer

Integer

5

No

NA

zvmRunning

String

RUNNING

No

Actual status indicator text on the last line for the Running mode.

The default is RUNNING.

zvmVmRead

String

VM READ

No

Actual text of the status indicator on the last line for the VM Read mode

The default is VM READ.

accessType

Integer

Yes

0 or 1

Specifies the HMC connection schema, 0 = SNMP, 1 = REST web services

communityName

String

Empty

Yes, when accessType = 0

Community string when selecting the SNMP access type.

hostname

String

Empty

Yes

Host name or  IP address of the HMC

snmpPort

Integer

161

No

SNMP port

Do not change the default.

timeout

Integer

60000

No

Timeout in milliseconds

An error is generated if the HMC does not respond in the specified timeout.

username

String

Empty

Yes, when accessType = 1

Username for the HMC web service credentials

password

String

Empty

Yes, when accessType = 1

Password for the HMC web services credentials

ports

String

(List of integers separated by comma)

514

No

Comma-separated list of integers

List of ports for the server to listen on

This is an unencrypted connection.

tlsPorts

String

(List of integers separated by comma)

6514

No

Comma-separated list of integers

List of ports for the server to listen on

This is an encrypted connection.

ports

String

162

No

List of numbers separated by comma

The list of ports to be listened to check for SNMP traps

trapReceiverEnabled

Boolean

false

No

The automation server listens to the SNMP ports for traps when this is true.

cellId

Integer

Yes

Must be a cell ID

ID of the cell

viewers

Array of viewer properties

NA

NA

NA

name

String

none (taken from URI path)

Read-only

Name of the viewer

allSession

Boolean

false

No

True if the viewer includes all automation sessions, false if it is a subset

description

String

empty

No

Description of the viewer as provided by the administrator when the viewer was created

dateCreated

Date

No

Read-only

Date when the viewer was originally created

This value is read-only and is automatically updated when the server is created.

dateUpdated

Date

Read-only

Date on which the viewer was last updated

This value is read-only and is automatically updated when the server is updated.

userCreated

String

Read-only

User who created this viewer

This is read-only and is updated automatically. 

bgcolor

String

000000

RGB color values in hexadecimal format

mainframeGreen

String

32cd32

RGB value in hexadecimal format to show messages in the mainframe green color

mainframeBlue

String

87ceeb

RGB value in hexadecimal format to show messages in the mainframe blue color

mainframeCyan

String

40f4f4

RGB value in hexadecimal format to show messages in the mainframe cyan color

mainframeMagenta

String

ffc0cb

RGB value in hexadecimal format to show messages in the mainframe magenta color

mainframeRed

String

ff1919

RGB value in hexadecimal format to show messages in the mainframe red color

mainframeWhite

String

ffffff

RGB value in hexadecimal format to show messages in the mainframe white color

mainframeYellow

String

ffff00

RGB value in hexadecimal format to show messages in the mainframe yellow color

colorNN

String

RGB value in hexadecimal format to show messages that were assigned custom colors. Custom colors are color9 through color19

sessions

Array of automation session

NA

id

Integer

NA

NA

Field is generated as identity when created

It is read-only for update.

name

String

Yes

Length <= 40

Letters, numbers, dash, hyphens, and spaces are allowed

description

String

""

No

Length <= 200

NA

server

String

NA

Yes

Value is taken from URI path

sessionId

Integer

No

Read-only field

Value is taken from the URI path.

operatorConfirm

Boolean

false

Yes

NA

repeat

Boolean

false

Yes

NA

rdl2Function

String

Yes

length <= 200

NA

parameters

String

""

Yes

Length <= 200

NA

frequency

Integer

0 = hourly, 1 = daily, 2 = weekly

hourOffset

Integer

0

NA

minuteOffset

Integer

0

NA

dayOffset

Time

NA

weeklyMonday

Boolean

false

Execute on Mondays

When frequency is weekly, at least once from Monday through Friday is required.

weeklyTuesday

Boolean

false

Execute on Tuesdays

weeklyWednesday

Boolean

false

Execute on Wednesdays

weeklyThursday

Boolean

false

Execute on Thursday

weeklyFriday

Boolean

false

Execute on Fridays

weeklySaturday

Boolean

false

Execute on Saturdays

weeklySunday

Boolean

false

Execute on Sundays

timeOnce

Time

Required when repeat is false

userCreated

String

Read-only

NA

dateCreated

Timestamp

Read-only

NA

dateUpdated

Timestamp

Read-only

NA

cells

Array of BAROC connections 

NA

NA

Read-only

NA

id

Integer

NA

NA

Read-only

NA

cellType

String

Must be cell or gateway.imcomm

name

String

Name of the cell

It must be a unique name.

encryptionKey

String

Encryption key name

addressAndPort

String

Must be in the format {hostname}/{port}

In this string:

• hostname is an IP address or valid hostname (For example, <localhost>)
• port is an integer