Jump to: navigation, search

GetSystemSettings

Purpose

The purpose is to provide available options. This particular service aims at providing users with a picture of UCS information, regardless of which client is connected behind a proxy.

The service could also serve as an audit on a UCS instance.

URL

  • GET /SystemInformation/GetServerTime/

Success

Parameters

Key ValueType Value Description Mandatory Unique Default
Host KVList The host information summary (as seen in Configuration, or audited). true true
Ports KVList The list of ports defined and their options. true true
Database KVList Describe database information. true true
ApplicationOptions KVList The application options as seen in Options Tab of Configuration. true true
ClusterOptions KVList The cluster options as seen in Options Tab of Configuration. true true
Options KVList Merged list of application options and cluster options. true true


Host

Key ValueType Value Description Mandatory Unique Default
HostName String The host name as defined in Host information in Configuration. true true
IPAddress String IP Address as defined in Host information in Configuration. true true
LCAPort String LCA Port as defined in Host information in Configuration. true true


Ports

Key ValueType Value Description Mandatory Unique Default
(PortId) KVList The port ID and associated options as defined in Application Server Info in Configuration. true true


(PortId)

Key ValueType Value Description Mandatory Unique Default
Id String The port ID as defined in Application Server Info in Configuration. true true
Port String Listening port as defined in Application Server Info in Configuration. true true
Protocol String Protocol as defined in Application Server Info in Configuration. true true
IsSecured Token yes or no Specifies if the port is secured. true true


DatabaseInfo attributes

Key ValueType Value Description Mandatory Unique Default
(DAPName) KVList The database information for this DAP. true true


DAPName

Key ValueType Value Description Mandatory Unique Default
DBMSName String The database information from Configuration Server DAP. true true
DBMSType String The database information from Configuration Server DAP. true true
DBMSRole Token main or archive Specifies the Role of the database.

Possible values are: Main, Archive

true true

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on May 18, 2018, at 07:05.