Data: ns1

  • Namespace: http://videoscape.cisco.com/oci

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 CustomFile

Entity representing a custom file uploaded by users to the installer manager and deployed by the agent on vms nodes

Example XML

<?xml version="1.0" encoding="UTF-8"?><CustomFile xmlns="http://videoscape.cisco.com/oci"> <customFilePk>...</customFilePk> <targetPath>...</targetPath> <targetModule> <modulePk>...</modulePk> <code>...</code> <name>...</name> <displayName>...</displayName> <lastUpdated>...</lastUpdated> <datasources> <datasource> <datasourcePk>...</datasourcePk> <name>...</name> <displayName>...</displayName> <moduleCode>...</moduleCode> <database> <databasePk>...</databasePk> <name>...</name> <username>...</username> <dbSchema>...</dbSchema> <connectionString>...</connectionString> </database> <type>...</type> <isUpdaterTarget>...</isUpdaterTarget> </datasource> <datasource> <!--...--> </datasource> <!--...more "datasource" elements...--> </datasources> <endpoints> <endpoint> <endpointPk>...</endpointPk> <protocol>...</protocol> <publicHostname>...</publicHostname> <publicPort>...</publicPort> <moduleCode>...</moduleCode> <trafficType>...</trafficType> <contextRoot>...</contextRoot> </endpoint> <endpoint> <!--...--> </endpoint> <!--...more "endpoint" elements...--> </endpoints> <databaseUpdaters> <databaseUpdater> <updaterPk>...</updaterPk> <sourceModuleCode>...</sourceModuleCode> <targetDatasourceName>...</targetDatasourceName> <state>...</state> <batch>...</batch> <targetVersion>...</targetVersion> <previousVersion>...</previousVersion> <applicationName>...</applicationName> </databaseUpdater> <databaseUpdater> <!--...--> </databaseUpdater> <!--...more "databaseUpdater" elements...--> </databaseUpdaters> <deploymentHome>...</deploymentHome> </targetModule> <name>...</name> <filename>...</filename> <lastUpdated>...</lastUpdated> <placeInsideDeploymentHome>...</placeInsideDeploymentHome> <extractOnDeployment>...</extractOnDeployment> <deployOnlyWhenJBossIsStopped>...</deployOnlyWhenJBossIsStopped> <checksum>...</checksum> <isActive>...</isActive> <log4jFragment>...</log4jFragment> <isLog4jAppender>...</isLog4jAppender></CustomFile>

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

Example XML

<?xml version="1.0" encoding="UTF-8"?><packageMetadata xmlns="http://videoscape.cisco.com/oci"> <package>...</package> <moduleDependency>...</moduleDependency> <moduleDependency>...</moduleDependency> <!--...more "moduleDependency" elements...--></packageMetadata>

Element ssoIdentityStore

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

Example XML

<?xml version="1.0" encoding="UTF-8"?><ssoIdentityStore xmlns="http://videoscape.cisco.com/oci"> <ssoUsers> <ssoUsers>...</ssoUsers> <ssoUsers>...</ssoUsers> <!--...more "ssoUsers" elements...--> </ssoUsers> <ssoGroups> <ssoGroups>...</ssoGroups> <ssoGroups>...</ssoGroups> <!--...more "ssoGroups" elements...--> </ssoGroups></ssoIdentityStore>

Type CustomFile

Entity representing a custom file uploaded by users to the installer manager and deployed by the agent on vms nodes

Child Elements

name (type) min/max
occurs
description
customFilePk (int) 0/1 get the entity pk
targetPath (string) 0/1 get the target path
targetModule (Module) 0/1 get the target module - the agent will deploy this custom file only on nodes where the target module is installed
name (string) 1/1 get the name
filename (string) 0/1 get the file name - cannot be changed once the custom file is persisted
lastUpdated (dateTime) 1/1 get the last updated timestamp
placeInsideDeploymentHome (boolean) 1/1 place the file inside the target module's deployment home
extractOnDeployment (boolean) 1/1 flag indicating the agent should extract the file as though it is zip compatible
deployOnlyWhenJBossIsStopped (boolean) 1/1 flag indicating the agent should only deploy this file when jboss is stopped
checksum (string) 0/1 checksum of file
isActive (boolean) 1/1 is this custom file active (agents ignore inactive custom files)
log4jFragment (string) 0/1 Gets the log4j fragment.
isLog4jAppender (boolean) 1/1 Checks if is log4j appender.

Type Database

Entity representing a database used by VMS

Child Elements

name (type) min/max
occurs
description
databasePk (int) 0/1 entity pk
name (name) 1/1 (no documentation provided)
username (string) 1/1 database connection username
dbSchema (string) 1/1 database connection schema
connectionString (string) 1/1 database connection string

Type DatabaseUpdater

A VMS database updater, defined in one updater.xml and one or more versions.xml

Child Elements

name (type) min/max
occurs
description
updaterPk (int) 0/1 entity pk
sourceModuleCode (byCode) 1/1 get source module's code
targetDatasourceName (string) 1/1 target datasource name
state (state) 1/1 updater state, as executed by the installer manager
batch (batch) 1/1 batch type, as executed by the installer manager
targetVersion (string) 1/1 target version - the largest version number in the versions.xml files for this updater, as detected at packaging time
previousVersion (string) 1/1 the previous value of the target version field for this updater (applied at package metadata import)
applicationName (string) 1/1 application name - fetched by the packager from updater.xml definitions

Type Datasource

Persistence datasource used by a vms module

Child Elements

name (type) min/max
occurs
description
datasourcePk (int) 0/1 entity pk
name (string) 1/1 datasource name
displayName (string) 1/1 datasource display name
moduleCode (byCode) 1/1 get owning module code
database (Database) 0/1 database to which this datasource is mapped
type (type) 1/1 type of datasource
isUpdaterTarget (boolean) 1/1 a module can have multiple datasources, but only one of them can be considered the target for database updaters (due to the dbupdaterproject structure)

Type Endpoint

Load-balanced network endpoint url used by vms for ui and webservice calls

Child Elements

name (type) min/max
occurs
description
endpointPk (int) 0/1 entity pk
protocol (protocol) 1/1 protocol
publicHostname (string) 1/1 hostname
publicPort (int) 1/1 port number [mandated]
moduleCode (byCode) 1/1 owning module code
trafficType (trafficType) 1/1 traffic type
contextRoot (string) 1/1 context root of the url - requests are resolved to endpoints via the context root, on a longest-match basis

Type JBossNode

A vms jboss node

Child Elements

name (type) min/max
occurs
description
jbossNodePk (int) 0/1 get entity pk
nodeId (string) 1/1 get node id
hostname (string) 1/1 get hostname
ramMB (int) 1/1 RAM in MB
lastUpdated (dateTime) 1/1 last updated time
jBossState (JBossState) 1/1 jboss runtime state, as determined by the agent; this value should only be considered relevant if the node is active (as returned byisActive())
packages/package (Package) 1/unbounded packages installed on this node
jBossCommand (JBossCommand) 1/1 jboss control command for the agent to execute
agentCommand (agentCommand) 1/1 command to be executed by the agent
upgradePartition (upgradePartition) 1/1 upgrade partition to which this node belongs
operationStates (string) 0/1 Get the operation states applied to this node, if any.

Type Module

A VMS module - a component of the VMS application, commonly identified by a code enumeration.

Child Elements

name (type) min/max
occurs
description
modulePk (int) 0/1 entity pk
code (byCode) 1/1 module code
name (string) 1/1 module name - should correspond to the updater application name, deployment home [without extension]
displayName (string) 1/1 module display name
lastUpdated (dateTime) 1/1 last updated timestamp
datasources/datasource (Datasource) 1/unbounded datasources that belong to this module
endpoints/endpoint (Endpoint) 1/unbounded endpoints that belong to this module
databaseUpdaters/databaseUpdater (DatabaseUpdater) 1/unbounded database updater originating from this module
deploymentHome (string) 0/1 deployment home - for modules that represent applications deployed on jboss's /deploy, the file/directory name (including extension) ofthe application archive/directory, as placed in /deploy

Type ModuleDependency

A container for a dependency check of a given module and version

Child Elements

name (type) min/max
occurs
description
code (byCode) 1/1 module code
version (string) 1/1 module's package version
displayName (string) 1/1 module display name

Type Package

A package (RPM) contains one or more modules

Child Elements

name (type) min/max
occurs
description
packagePk (int) 0/1 entity pk
name (string) 1/1 package name
displayName (string) 1/1 package display name
modules/module (Module) 1/unbounded modules that belong to this package
currentVersion (string) 1/1 current package version; installed rpm's must match this version
previousVersion (string) 1/1 previous version of this package (before the package selection step of the latest upgrade)
lastUpdated (dateTime) 1/1 timestamp of last update of this entity
jbossNodePks/jbossNodePk (int) 0/unbounded jboss node pks on which this package is installed

Type ssoGroup

An SSO group used in migration; belongs to an SSOIdentityStore.

Child Elements

name (type) min/max
occurs
description
groupName (string) 1/1 group name
modules/module (string) 0/unbounded modules that are required for this group to exist

Type ssoUser

A container for SSO user information - generated by the SSO migration tool (or manually) and used by the Agent to create users with thecorrect properties.

Child Elements

name (type) min/max
occurs
description
uid (string) 1/1 user id
passwordEnc (string) 1/1 SSO-encrypted password
status (userStatus) 1/1 user status
groups/group (string) 1/unbounded groups to which this user belongs
aliases/alias (string) 0/unbounded user aliases [custom fields in key=value format]
locale (string) 1/1 user locale