Data

  • Default Namespace

The data in this namespace is divided into elements and types. Types define the structure of the data. Elements define specific instances of the types, and are therefore more relevant to REST endpoints, which generally consume and/or produce elements.

The following elements are members of this namespace:

The following types are members of this namespace:

Element cluster

A container for voldemort servers, used in generating FFS configuration

Example XML

<?xml version="1.0" encoding="UTF-8"?><cluster> <name>...</name> <server> <id>...</id> <host>...</host> <http-port>...</http-port> <socket-port>...</socket-port> <partitions>...</partitions> </server> <server> <!--...--> </server> <!--...more "server" elements...--></cluster>

Type agentCommand

command given to the agent to perform various tasks

Possible Values

value description
NONE
GRACEFUL_TERMINATION
SOLR_MASTER_STANDBY_SWITCHOVER
SOLR_MASTER_STANDBY_RESTORE
LOG_AGGREGATION
FFS_PRIMARY_RESTORE
TOMCAT_START
TOMCAT_STOP
TOMCAT_RESTART

Type batch

updater batch type

Possible Values

value description
PRE
MAIN
POST

Type byCode

module code enumeration

Possible Values

value description
JBOSS
TOMCAT
ESB
JUDDI
JBESB
JBPM
CM
PT
CP
WS
EM
RM
OCC
KMS
OCI
SM
SCM
LM
MM
MERCH
CTM
FFS
FFS_SLAVE
FFS_REPEATER
SSO
OCESB_BIND
OCESB_COLLATOR
OCESB_DRMCOLLATOR
OCESB_CORE
OCESB_DRMPACKAGER
OCESB_DYNAMICQUEUE
OCESB_WORKFLOWJOIN
OCESB_ENCODER
OCESB_PRODUCTIZE
OCESB_REPOSITORYMGR
OCESB_XMLREAD
OCESB_LOADCOMPONENTXML
OCESB_LOADEXISTINGCOMPONENTXML
OCSESB_XMLTRANSFORM
OCESB_ARMADA
OCESB_RHOZET
OCESB_CUSTOM
OCESB_MANAGE_COMPONENT
OCESV_CDSTV
OCESB_FILEDISCOVERY
OCESB_GENERICRULES
OCESB_MAPPINGRULES
OCESB_INGEST
OCESB_XLS_INGEST
OCESB_XLSC_INGEST
OCESB_IMAGE_TRANSFORM
OCESB_METADATA_AUGMENTATION
OCESB_MOSVOD
OCESB_SOURCEDATA
OCESB_MEDIA_MANAGER
OCESB_CLASSIFICATION_INGESTION
OCESB_MM_TASK_SPLITTER
SOLR_MASTER
SOLR_MASTER_STANDBY
SOLR_SLAVE
SOLR_REPEATER
AGENT
MOD_CLUSTER
TOMCAT_MOD_CLUSTER
VCM_UI
VCS_CONSOLE
VCS_TOMCAT
MERCH_SERVER
CLIENTIMPL

Type JBossCommand

command given to the agent to start/stop the jboss server

Possible Values

value description
NONE
STOP
START
RESTART

Type JBossState

state of the jboss server

Possible Values

value description
RUNNING
TRANSITION
STOPPED

Type name

Possible Values

value description
MAIN
REPORTING

Type packageMetadata

Package information for the installer is generated by the packager at build time, in the form of several package metadata. This entityencompasses a package and a set of dependencies. A marshalled copy is placed on-disk for the InstallerManager to read at startup time. The xmlfor each metadata is then written into OCI_RESOURCE. It is read and unmarshalled at package selection time, where OCI database entities arecreated/updated.

Child Elements

name (type) min/max
occurs
description
package () 0/1 package encompassed by this metadata object
moduleDependency () 0/unbounded module dependencies for this package

Type protocol

protocol for use with this endpoint

Possible Values

value description
HTTP
HTTPS

Type server

A configuration container representing a single voldemort [FFS] node

Child Elements

name (type) min/max
occurs
description
id (string) 1/1 node id
host (string) 1/1 node hostname
http-port (int) 1/1 get http port number
socket-port (int) 1/1 get socket port
partitions (string) 1/1 partition number comma-delimited list

Type SSOIdentityStore

A container for all VMS-relevant information that can be imported and exported to/from SSO. Used in the SSO migration process.

Child Elements

name (type) min/max
occurs
description
ssoUsers/ssoUser () 1/unbounded users
ssoGroups/ssoGroup () 1/unbounded groups

Type state

updater execution state, as controlled by the installer manager

Possible Values

value description
IMPORTED
UPDATING
COMPLETE
ERROR

Type trafficType

The traffic type indicates the type of call performed via the url represented by this endpoint

Possible Values

value description
WEB_GUI
WEB_NON_GUI
SOAP_WS
REST_WS
REST_WS_PUBLISHED
SOAP_WS_PUBLISHED

Type type

datasource type

Possible Values

value description
XA
LOCAL_TX
LOCAL_NON_TX

Type upgradePartition

the vms deployment can be split in half for rolling a-side/b-side upgrades; when this is done, all nodes in the deployment must bepartitioned to designate them in one of two upgrade partitions - FIRST or LAST, depending on which half is upgraded first and last

Possible Values

value description
NONE
FIRST
LAST

Type userStatus

user status

Possible Values

value description
ACTIVE
INACTIVE

Type voldemortCluster

A container for voldemort servers, used in generating FFS configuration

Child Elements

name (type) min/max
occurs
description
name (string) 1/1 get the FFS name
server (server) 1/unbounded collection of voldemort servers