Versions Compared

Version Old Version 6 New Version Current
Changes made by

IT Stonebranch

Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

<ul> <li> If <b>retainSysIds</b>
  • If retainSysIds="true"
and <code>sysId</code> is included in the
  • and sysId is included in the request/response,
<code>sysId</code> will be persisted to the database. <li> If <b>retainSysIds</b>
  •  sysId will be persisted to the database.
  • If retainSysIds="false"
and <code>sysId</code> is included in the request/response, <code>sysId</code> will be ignored; it will be autogenerated by the Controller. </ul>
  • and sysId is included in the request/response, sysId will be ignored; it will be autogenerated by the Controller.



Property

UI Field Name

Description

Specifications

Required

Anchor
authenticate - oms
authenticate - oms
authenticate

Authenticate OMS Server

Specification for whether or not the Controller authenticates the OMS server digital certificate.

Boolean; Valid values: true/false. Default is false.

N

Anchor
description - oms
description - oms
description

Description

User-defined; description of this record.


N

Anchor
excludeRelated - oms
excludeRelated - oms
excludeRelated

n/a

For the Modify OMS Server web service; specification for whether or not to exclude related records from the update, even if they are provided in the request.
 


Note
titleNote

In XML, excludeRelated is specified as an attribute in the <omsServer> element.


Valid values: true/false (default is false).

No

Anchor
exportReleaseLevel - oms
exportReleaseLevel - oms
exportReleaseLevel

n/a

Universal Controller release that the record was exported from.

read onlyN

Anchor
exportTable - oms
exportTable - oms
exportTable

n/aRecord table information.read onlyN

Anchor
lastConnected - oms
lastConnected - oms
lastConnected

Last Connected Server Address

OMS Server, in a High Availability environment of multiple cluster nodes, that is connected to the Controller or was last connected to the Controller.

Read-only.

n/a

Anchor
lastConnectedTime - oms
lastConnectedTime - oms
lastConnectedTime

Last Connected TimeTime when the Universal Controller last connected to the server.Read-only.n/a

Anchor
opswiseGroups - oms
opswiseGroups - oms
opswiseGroups

Member of Business Services

Business Services that this record belongs to.
 
Format:
 
XML

<pre> &lt;opswiseGroups&gt; &lt;opswiseGroup&gt;test&lt;/opswiseGroup&gt; &lt;/opswiseGroups&gt; </pre>
<opswiseGroups>
  <opswiseGroup>test</opswiseGroup>
</opswiseGroups>
Panel
Html bobswift

 
JSON

html-bobswift
Panel
<pre> 
"opswiseGroups": ["test"]
</pre>


N
 Anchor
retainSysIds - oma
retainSysIds - oma
 retainSysIds
n/a
Specification for whether or not the Create an OMS Server web service will persist the sysId property.
 Html bobswift
 Note
titleNote
In XML web services, retainSysIds is specified as an attribute in the <omsServer> element.

Valid values: true/false (default is true).
N
 Anchor
serverAddress - oms
serverAddress - oms
serverAddress
OMS Server Address
IP address or host name of an OMS Server, or a comma-separated list of OMS Servers configured as an OMS Server cluster.

Y
 Anchor
sessionStatus - oms
sessionStatus - oms
sessionStatus
Session Status
Current status of the OMS server messaging sessions: heartbeat, input, and output sessions.
Read-only. Valid values:
 Html bobswift<ul>
<li> None
<li> Impaired
<li> Operational
</ul>
  • None
  • Impaired
  • Operational
n/a
 Anchor
status - oms
status - oms
status
Status
Current status of the OMS server.
Read-only. Valid values:
 Html bobswift<ul>
<li> Disconnected
<li> Connected
</ul>
  • Disconnected
  • Connected
n/a
 Anchor
suspended - oms
suspended - oms
suspended
Suspended
Indication of whether or not the OMS Server has been suspended.
Read -only.  Valid values: true/false.
n/a
 Anchor
sysId - oms
sysId - oms
sysId
n/a
System ID field in the database for this OMS Server record.
Persisted only if retainSysIds is set to true.
N
 Anchor
timeout - oms
timeout - oms
timeout
Network Timeout (Seconds)
Network socket time-out value used for TCP/IP receive and connect operations.
Integer.
N
...
Property
UI Field Name
Description
Specifications
Required
 Anchor
bcc - email
bcc - email
bcc
Bcc
Email address of the party being sent a blind (hidden) copy of the email, if any.
Use commas to separate multiple recipients. Variables and Functions are supported.
N
 Anchor
body - email
body - email
body
Body
Text of the email message.
Variables and Functions are supported. If the emailTemplate contains text in the body, this text is appended.
N
 Anchor
cc - email
cc - email
cc
Cc
Email address of the party being sent a copy of the email, if any.
Use commas to separate multiple recipients. Variables and Functions are supported.
N
 Anchor
emailConnection - email
emailConnection - email
emailConnection
Email Connection
Name of an Email Connection.
If you specify both an emailConnection and an emailTemplate, the Controller uses the emailConnection.
Y 
(unless emailTemplate 
is specified)
 Anchor
emailTemplate - email
emailTemplate - email
emailTemplate
Email Template
Name of an Email Template.
If you specify both an emailConnection and an emailTemplate, the Controller uses the emailConnection.
Y 
(unless emailConnection 
is specified)
 Anchor
replyTo - email
replyTo - email
replyTo
Reply-To
Email address of the sender of the email.
Use commas to separate multiple recipients. Variables and Functions are supported.
N
 Anchor
status - email
status - email
status
Status Options
Comma-separated list of statuses
Valid values:
html-bobswift
<ul>
<li> 
  • As 
 
  •  String 
 
  •  = 
 
  •  Disconnected, 
 
  •  As 
 
  •  Value 
 
  •  = 
 
  •  0

<li> 
  • As 
 
  •  String 
 
  •  = 
 
  •  Connected, 
 
  •  As 
 
  •  Value 
 
  •  = 
 
  •  1

</ul>
N
 Anchor
subject - email
subject - email
subject
Subject
Subject line of the email.
Variables and Functions are supported.
N
 Anchor
sysId - email
sysId - email
 sysId
n/a
sys_id used within the Controller to identify this Email Notification.

N
 Anchor
to - email
to - email
 to
To
Email address of the recipient.
Use commas to separate multiple recipients Variables and Functions are supported.
N
...
Property
UI Field Name
Description
Specifications
Required
 Anchor
severity - snmp
severity - snmp
severity
Notification Severity
Severity level of this notification.
Valid values:
html-bobswift
<ul>
<li> 
  • As 
 
  •  String 
 
  •  = 
 
  •  Normal, 
 
  •  As 
 
  •  Value 
 
  •  = 
 
  •  1

<li> 
  • As 
 
  •  String 
 
  •  = 
 
  •  Warning, 
 
  •  As 
 
  •  Value 
 
  •  = 
 
  •  2

<li> 
  • As 
 
  •  String 
 
  •  = 
 
  •  Minor, 
 
  •  As 
 
  •  Value 
 
  •  = 
 
  •  3

<li> 
  • As 
 
  •  String 
 
  •  = 
 
  •  Major, 
 
  •  As 
 
  •  Value 
 
  •  = 
 
  •  4

<li> 
  • As 
 
  •  String 
 
  •  = 
 
  •  Critical, 
 
  •  As 
 
  •  Value 
 
  •  = 
 
  •  5

</ul>
Default is Normal (1).
N
 Anchor
snmpManager - snmp
snmpManager - snmp
snmpManager
SNMP Manager
SNMP Manager that will receive this notification.

N
 Anchor
status - snmp
status - snmp
status
Status Options
Comma-separated list of statuses
Valid values:
html-bobswift
<ul>
<li> 
  • As 
 
  •  String 
 
  •  = 
 
  •  Disconnected, 
 
  •  As 
 
  •  Value 
 
  •  = 
 
  •  0

<li> 
  • As 
 
  •  String 
 
  •  = 
 
  •  Connected, 
 
  •  As 
 
  •  Value 
 
  •  = 
 
  •  1

</ul>
N
 Anchor
sysId - snmp
sysId - snmp
sysId
n/a
sys_id used within the Controller to identify this SNMP Notification.

N
...