Versions Compared

Version Old Version 3 New Version Current
Changes made by

Stonebranch

Stonebranch

Saved on

Key

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

...

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).

NoN

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

Panel
<opswiseGroups>
  <opswiseGroup>test</opswiseGroup>
</opswiseGroups>

 
JSON

Panel
"opswiseGroups": ["test"]



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.

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



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:

  • None
  • Impaired
  • Operational

n/a

Anchor
status - oms
status - oms
status

Status

Current status of the OMS server.

Read-only. Valid values:

  • 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

...