4 Reference Tables

This chapter provides tabular reference information for connectors. The following sections provide reference tables for the following categories:

This chapter also provides information about the response file properties that the Create RAC and Add Node jobs generate for the Windows platform.

Request Attributes

The tables in this section provide query paths, descriptions, and data types for the following property types:

  • setModel Request

  • Request Header

  • Create RAC

  • Add Node

  • Delete Node

Table 4–1 provides path types, descriptions, and data types for setModel request elements.

Table 4-1 setModel Request Elements

Path Type Description Data Type

<EMModel xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance xmlns="http://xmlns.oracle.com/sysman/connector/base/msi">

EMModel element.

Complex Type

<RequestHeader/>

Request header. See Table 4–2.

Complex Type

<Credential>

Credential for Enterprise Manager.

Complex Type

<Name>sysman</Name>

User name.

String

<Password>welcome1

</Password>

Password.

String

</Credential>

End of Credential.

Complex Type

<AggregateTarget>

EMModel should contain two aggregate targets: one of type cluster, and one of type rac_database. This aggregate target is of type cluster. It contains information about the cluster.

Complex Type

<Name>CRS30</Name>

Name of the cluster.

String

<Type>cluster</Type>

Aggregate target type.

String (enumeration: "cluster" "rac_database"

<Target>

Number of targets in the cluster aggregate target should be the same as the number of hosts in the cluster. Each target element contains information about a host in the cluster.

Complex Type

<Name>bjx30</Name>

Name of the host.

String

<Type>host</Type>

Target type. In the cluster aggregate target, it should be set to "host."

String

<Host>bjx30</Host>

Name of the host.

String

<Credential>

Credential of the host.

Complex Type

<Name>oracle</Name>

User name.

String

<Password>welcome1

</Password>

Password.

String

</Credential>

End of Credential.

Complex Type

<Property/>

Property of the target. See the corresponding table in this section for the properties of the "host" target type.

Complex Type

</Target>

End of Target.

Complex Type

<Property/>

Property of the cluster aggregate target. See the corresponding table in this section for the properties of the "cluster" aggregate target type.

Complex Type

</AggregateTarget>

End of AggregateTarget.

Complex Type

<AggregateTarget>

EMModel should contain two aggregate targets: one of type cluster and one of type rac_database. This aggregate target is of type rac_database. It contains information about the RAC.

Complex Type

<Name>RAC30</Name>

Name of the RAC database.

String (length <=8)

<Type>rac_database</Type>

Aggregate target type.

String (enumeration: "cluster" or "rac_database")

<Storage>

Storage element contains storage information for the RAC. This element can be omitted for the Add Node job request if the storage type is not ASM.

Complex Type

<Type>ASM</Type>

Type of storage.

String (enumeration: "CFS" or "ASM." "RAW" is not supported.)

<Property/>

Properties for storage. See the corresponding table in this section for the storage properties.

Complex Type

</Storage>

End of Storage.

Complex Type

<Target>

The number of targets in the rac_database aggregate target should be the same as the number of database instances in the cluster database. Each target element contains information about a database instance in the RAC database.

Complex Type

<Name>RAC30_RAC301</Name>

Name of the target, which should be in the format of <rac_name>_<rac_instance_name>.

String

<Type>oracle_database</Type>

Target type. In the rac_database aggregate target, it should be set to "oracle_database."

String

<Host>bjx30</Host>

Name of the host.

String

<Credential>

Credential of the host.

Complex Type

<Name>oracle</Name>

User name.

String

<Password>welcome1

</Password>

Password.

String

</Credential>

End of Credential.

Complex Type

<Property/>

Property of the target. See the corresponding table in this section for the properties of the "oracle_database" target type.

Complex Type

</Target>

End of Target.

Complex Type

<Property/>

Property of the rac_database aggregate target. See the corresponding table in this section for the properties of the "rac_database" aggregate target type.

Complex Type

</AggregateTarget>

End of AggregateTarget.

Complex Type

</EMModel>

End of EMModel.

Complex Type

Table 4–2 provides path types, descriptions, and data types for request header elements.

Table 4-2 Request Header Elements

Path Type Description Data Type

<RequestID/>

Uniquely identifies the request. This is mainly used by the client. Enterprise Manager currently does not track this ID.

String

<Source/>

Request source, which is the request operating system.

String

<Destination/>

Destination should be Enterprise Manager in this release.

String

<RequestProperty>

<Type>Singleton</Type>

<Property>

<Name>Platform</Name>

<Value>Linux</Value>

</Property>

</RequestProperty>

Platform is an optional property. Specify either Linux or Windows. If you do not specify a platform, the default is Linux. The platform is only relevant in provisioning use cases.

  

Table 4–3 provides target types, properties, descriptions, and data types for Create RAC.

Table 4-3 Create RAC Properties

Target Type Property Description Data Type

<Target>

<Type>host</Type>

</Target>

CRS_HOME

Oracle Clusterware home directory. This property must be the same for all hosts in the cluster.

String
 

ORACLE_HOME_NAME

Oracle Clusterware home name. This is an optional property. The default value is the cluster aggregate target name.

String
 

publicNode

Public node name.

String
 

privateNode

Private node name.

String
 

vipNode

Virtual node name.

String

<Target>

<Type>oracle_database</Type>

</Target>

ORACLE_HOME

Database home directory. This property must be the same for all database instances in the RAC database.

String
 

ORACLE_HOME_NAME

Database home name. This property is optional. The default value is the rac_database aggregate target name.

String
 

db_username

Database user for setting monitoring credentials. It should always be SYS in this release.

String
 

db_password

Password of the database user. It is the password for SYS and SYSTEM in this release.

String
 

oms_username

Oracle Management Services host operating system user name.

String
 

oms_password

Oracle Management Services host operating system password.

String

<Storage>

<Type>ASM</Type>

</Storage>

diskGroupName

ASM disk group name.

String
 

diskList

Disk device list. Use a comma ( , ) as a separator.

String (no space allowed)
 

diskString

Search paths for ASM disks.

String (no space allowed)
 

redundancy

Redundancy level.

String (enumeration: NORMAL, HIGH, or EXTERNAL)
 

asmPassword

ASM SYSDBA password.

String

<Storage>

<Type>CFS</Type>

</Storage>

datafileDestination

Data file directory.

String

<AggregateTarget> <Type>cluster</Type>

</AggregateTarget>

softwareImageName

Name of the software library image for the CRS home. This property is optional. The default value is the latest active software library image of type "Oracle Clusterware Clone."

String
 

s_ocrpartitionlocation

OCR location. Use the comma (,) as a separator. This property is only for the Linux platform.

String (no space allowed)
 

s_votingdisklocation

Voting disk location. Use the comma (,) as a separator. This property is only for the Linux platform.

String (no space allowed)
 

RESPONSEFILE_VERSION

Response file version. This property is optional. The default value is 2.2.1.0.0. This property is only for the Windows platform.

String
 

sl_OHPartitionsAndSpace_valueFromDlg

This property specifies the split-up of disk partitions for OCR/Vdisk locations. This property is only for the Windows platform.

See Section , "Response File Properties for the Windows Platform" for more information.

String
 

ret_PrivIntrList

This property specifies the interconnects to use. This property is only for the Windows platform.

See Section , "Response File Properties for the Windows Platform" for more information.

String

<AggregateTarget>

<Type>rac_database</Type>

</AggregateTarget>

templateName

Database template name. This property is optional. The default value is General_Purpose.dbc

String (file name without path)
 

gdbName

Global database name. This property is optional. The default value is the rac_database aggregate target name.

String (length <=8)
 

sid

Database instance name. This should be the same as gdbName in this release. This property is optional. The default value is the rac_database aggregate target name.

String (length <=8)
 

characterSet

Character set. See the Database Globalization Support guide for details. This property is optional. The default value is UTF8.

String
 

nationalCharacterSet

National character set. See the Database Globalization Support guide for details. This property is optional. The default value is UTF8.

String
 

initParams

Raw strings for additional input. For example:

nls_territory=japan, nls_language=japanese

This property is optional. The default value is:

nls_lang=american,nls_territory=american

String (no space allowed)
 

softwareImageName

Name of the software library image for the database home. This property is optional. The default value is the latest active software library image of type "Oracle Database Clone."

String

Table 4–4 provides target types, properties, descriptions, and data types for Add Node for a RAC aggregate target.

Table 4-4 Add Node Properties (Storage and Aggregate Target)

Target Type Property Description Data Type

<Storage>

<Type>ASM</Type>

</Storage>

asmPassword

ASM SYSDBA password.

String

<AggregateTarget>

<Type>cluster</Type>

</AggregateTarget>

s_ocrpartitionlocation

OCR location. Use the comma (,) as a separator. This property is only for the Linux platform. Set this value to be the same as the Create RAC job.

String (no space allowed)
 

s_votingdisklocation

Voting disk location. Use the comma (,) as a separator. This property is only for the Linux platform. Set this value to be the same as the Create RAC job.

String (no space allowed)
 

RESPONSEFILE_VERSION

Response file version. This property is optional. The default value is 2.2.1.0.0. This property is only for the Windows platform. Set this value to be the same as the Create RAC job.

String
 

sl_OHPartitionsAndSpace_valueFromDlg

This property specifies the split-up of disk partitions for OCR/Vdisk locations. This property is only for the Windows platform. Set this value to be the same as the Create RAC job.

String
 

ret_PrivIntrList

This property specifies the interconnects to use. This property is only for the Windows platform. Set this value to be the same as the Create RAC job.

String

Table 4–5 provides target types, properties, descriptions, and data types for Add Node for a new node.

Table 4-5 Add Node Properties (New Node)

Target Type Property Description Data Type

<Target>

<Type>host</Type>

</Target>

CRS_HOME

Oracle Clusterware home directory. This property must be the same for all hosts in the cluster.

String
 

ORACLE_HOME_NAME

Oracle Clusterware home name. This property is optional. The default value is cluster aggregate target name.

String
 

publicNode

Public node name.

String
 

privateNode

Private node name.

String
 

vipNode

Virtual node name.

String

<Target>

<Type>oracle_database</Type>

</Target>

ORACLE_HOME

Database home directory. This property must be the same for all database instances in the RAC database.

String
 

ORACLE_HOME_NAME

Database home name. This property is optional. The default value is rac_database aggregate target name.

String
 

db_username

Database user name that has a SYSDBA role.

String
 

db_password

Password of the user above.

String
 

oms_username

Oracle Management Services host operating system user name.

String
 

oms_password

Oracle Management Services host operating system password.

String

Table 4–6 provides target types, properties, descriptions, and data types for Add Node for any existing node.

Table 4-6 Add Node Properties (Any Existing Node)

Target Type Property Description Data Type

<Target>

<Type>host</Type>

</Target>

publicNode

Public node name.

String
 

CRS_HOME

Oracle Clusterware home directory. This property must be the same for all hosts in the cluster.

String

<Target>

<Type>oracle_database</Type>

</Target>

ORACLE_HOME

Database home directories. This property must be the same for all database instances in the RAC database.

String

Table 4–7 provides target types, properties, descriptions, and data types for Delete Node for remaining nodes.

Table 4-7 Delete Node Properties (Remaining Nodes)

Target Type Property Description Data Type

<Target>

<Type>host</Type>

</Target>

CRS_HOME (or ORACLE_HOME)

Oracle Clusterware home directory.

String

<Target> <Type>oracle_database</Type>

</Target>

ORACLE_HOME

Database home directory.

String
 

db_username

Database user name that has a SYSDBA role.

String
 

db_password

Password of the user above.

String
 

oms_username

Oracle Management Services host operating system user name.

String
 

oms_password

Oracle Management Services host operating system password.

String

<AggregateTarget>

<Type>rac_database</Type>

</AggregateTarget>

oms_delete_all_targets

Removes all targets on the instance host, including the host and agent. This property is optional. The default value is False.

String (enumeration: True or False)

Response File Properties for the Windows Platform

The following properties are required to generate the response file for the Create RAC and Add Node jobs on the Windows platform:

  • sl_OHPartitionsAndSpace_valueFromDlg

  • ret_PrivIntrList

The following sections describe each response file property.

sl_OHPartitionsAndSpace_valueFromDlg Property

This property specifies the splitting up of disk partitions for OCR/Vdisk locations. It consists of the following six values for each location:

  • Disk no.

  • Partition no.

  • Partition Size (MB)

  • Format Type

    • 0: None/RAW

    • 1: CFS for data

    • 2: CFS for software

  • Drive Letter

    • N/A: RAW

    • "Available" drive letter: CFS

  • Usage Type

    • 0: Data/software use ONLY

    • 1: OCR primary ONLY

    • 2: Voting disk ONLY

    • 3: OCR primary and voting disk on the same CFS partition

    • 4: OCR mirror only

    • 5: OCR mirror and voting disk on the same CFS partition

Example 1

Given the following scenario:

  • OCR and the Voting Disk are on Partition-2 of Disk-1 (Partition-2 has size 10002 MB).

  • The partition is CFS-formatted.

  • Both OCR and the Voting Disk reside on the same partition.

  • The drive letter for the partition is G:.

  • There is only data storage and no software storage.

You would specify sl_OHPartitionsAndSpace_valueFromDlg as follows:

<Property>
    <Name>sl_OHPartitionsAndSpace_valueFromDlg</Name>
    <Value>{"1","2","10002","1","G:","3"}</Value>
</Property>

Example 2

Given the following scenario:

  • OCR and the Voting Disk reside on different partitions.

  • OCR is on Partition-1 of Disk-3, which has a size of 486 MB and is RAW-formatted.

  • The Voting Disk is on Partition-1 of Disk-4, which has a size of 486 MB and is RAW-formatted.

You would specify sl_OHPartitionsAndSpace_valueFromDlg as follows:

<Property>
    <Name>sl_OHPartitionsAndSpace_valueFromDlg</Name>
    <Value>{"3","1","486","0","N/A","1","4","1","486","0","N/A","2"}</Value>
</Property>

ret_PrivIntrList Property

This property specifies the interconnects to use. You should specify entries in ret_PrivIntrList as a comma-separated list of interfaces. Each entry should be a colon-separated string with three fields. You should specify the fields as follows:

  • The first field should be the interface name.

  • The second field should be the subnet IP of the interface.

  • The third field should indicate how Oracle Clusterware should use the interface: as a public interface, private interface, or whether it should not be used at all by the clusterware. This field should be specified as a number — 1, 2, or 3. These numbers represent the following values:

    • 1: Public

    • 2: Private

    • 3: Do not use

Example

Given the following scenario:

  • One "Local Area Connection" public interconnect is to be used.

  • One "Local Area Connection2" private interconnect is to be used.

You would specify ret_PrivIntrList as follows:

<Property>
    <Name>ret_PrivIntrList</Name>
    <Value>{"Local Area Connection:123.45.67.0:1","Local Area Connection 2:123.45.89.0:2"}</Value>
</Property>

Queryable Properties

The tables in this section provide property names, descriptions, and data types for the following types of queryable properties:

  • General Target

  • Oracle Database

  • Oracle Listener

  • Host Target

  • Cluster

  • Cluster Database

  • Oracle Enterprise Manager Agent

  • Oracle Enterprise Manager Repository Target

  • Job

Table 4–8 provides property names, descriptions, and data types for general target queryable properties.

Table 4-8 General Target Properties

Query Path Description Data Type

Property(Name:status)

Integer status of the Enterprise Manager target instance. (See Table 4–20.)

Integer

Property(Name:monitoring agent)

Enterprise Manager target instance name (of type oracle_emd) of the Agent monitoring the Enterprise Manager target instance.

String

Property(Name:homepage)

Enterprise Manager Console home page URI (the path portion of the URL, as in /em/console?...) of the Enterprise Manager target instance.

URL

Property(Name:version)

Version of the Enterprise Manager target instance.

String

Property(Name:oracle home)

Oracle home of the Enterprise Manager target instance. The form of the directory path (path separator) is not further specified here.

String

Property(Name:critical alerts)

Number of critical alerts against the Enterprise Manager target instance.

Integer

Property(Name:warning alerts)

Number of warning alerts against the Enterprise Manager target instance.

Integer

Property(Name:critical policy violations)

Number of critical policy violations against the Enterprise Manager target instance.

Integer

Property(Name:warning policy violations)

Number of warning policy violations against the Enterprise Manager target instance.

Integer

Property(Name:compliance score)

Compliance score as a real number between 0 and 1 (inclusive) of the Enterprise Manager target instance.

Number

Property(Name:last load time)

Last load time of the data for the target instance as the number of milliseconds since January 1, 1970, 00:00:00 GMT.

Number

Host

Enterprise Manager target instance name (of type host) of the host related to the Enterprise Manager target instance.

String

Table 4–9 provides property names, descriptions, and data types for Oracle Database queryable properties. The target type for the Oracle Database is oracle_database.

Table 4-9 Oracle Database Properties

Query Path Description Data Type

Property(Name:instance name)

Instance name of the database instance.

String

Property(Name:listener)

Listener Enterprise Manager target instance name (of type oracle_listener) of the listener for the database instance.

String

Property(Name:is archiving)

The value is 1 if high availability archiving is on for the Oracle database instance. Otherwise, the value is 0.

Integer

Property(Name:is flashback logging)

The value is 1 if high availability flashback logging is on for the Oracle database instance. Otherwise, the value is 0.

Integer

Table 4–10 provides property names, descriptions, and data types for Oracle listener properties. The target type for the Oracle listener is oracle_listener.

Table 4-10 Oracle Listener Properties

Query Path Description Data Type

Property(Name:alias)

Alias of the Oracle Listener instance.

String

Property(Name:net address)

Net address of the Oracle Listener instance.

URI

Property(Name:listener.ora location)

File directory location of the listener.ora file of the Oracle Listener instance. The form of the directory path (path separator) is not further specified here.

String

Property(Name:start name)

Start time of the Oracle Listener instance. The form of this time stamp is not further specified here.

Time

Table 4–11 provides property names, descriptions, and data types for host target properties. The target type for the Host is host.

To get the targets within the domain of a cluster, first request the cluster hosts with the "Target" sub-element. Then get all the targets and filter the list by the hosts in the cluster hosts list.

Table 4-11 Host Target Properties

Query Path Description Data Type

Property(Name:cluster)

Enterprise Manager target instance name (of type cluster) of the cluster for this host instance.

String

Property(Name:cpu utilization)

CPU utilization as a real number between 0 and 1 (inclusive) of the host.

Number

Property(Name:memory utilization)

Memory utilization as a real number between 0 and 1 (inclusive) of the host.

Number

Property(Name:total io rate)

Total I/O per second.

Number

Table 4–12 provides property names, descriptions, and data types for cluster properties. The target type for Oracle Clusterware is cluster.

Table 4-12 Cluster Properties

Query Path Description Data Type

Property(Name:version)

Clusterware version. Note that this property definition just redefines the same property defined for the general target mappings.

String

Property(Name:cluster database)

Cluster databases (of type rac_database).

String

Target

Cluster hosts (of type host).

String

Table 4–13 provides property names, descriptions, and data types for cluster database properties. The target type for the Oracle cluster database is rac_database.

Table 4-13 Cluster Database Properties

Query Path Description Data Type

Property(Name:cluster)

Enterprise Manager target instance name (of type cluster) of the cluster for this database instance.

String

Property(Name:database name)

Database instance name.

String

Property(Name:is archiving)

Value is 1 if high availability archiving is on for the cluster database. Otherwise, the value is 0.

Integer

Target

Cluster database instance of type oracle_database.

String

Table 4–14 provides property names, descriptions, and data types for Oracle Enterprise Manager Agent properties. The target type for the Oracle Management Agent is oracle_emd.

Table 4-14 Oracle Enterprise Manager Agent Properties

Query Path Description Data Type

Property(Name:management service)

OMS that the Enterprise Manager Agent instance uploads to.

String

Table 4–15 provides property names, descriptions, and data types for Oracle Enterprise Manager Repository target properties. The target type for the Oracle Management Repository is oracle_emrep.

Table 4-15 Oracle Enterprise Manager Repository Target Properties

Query Path Description Data Type

Property(Name:agent count)

Number of Agents for this repository instance.

Integer

Property(Name:target count)

Number of targets for this repository instance.

Integer

Property(Name:

administrator count)

Number of administrators for this repository instance.

Integer

Property(Name:session count)

Number of active Oracle management services repository sessions for this repository instance.

Integer

Property(Name:Integer)

Enterprise Manager database target instance(s) of the database(s) for this repository instance. This property is expanded into complex property elements in the response as described in Table 4–18. They are keyed by the "name" and "value" sub-properties.

String

Property(Name:tablespace)

Expands to the tablespaces used in the database for this repository instance.

String

Property(Name:oms)

OMSs for this Enterprise Manager repository. This property is expanded into complex property elements in the response as described in Table 4–17. They are keyed by the "name" sub-properties.

String

Table 4–16 provides property names, descriptions, and data types for job properties.

Table 4-16 Job Properties

Query Path Description Data Type

JobStatus

Integer status (see Table 4–20) of the most recent execution of the job.

Integer

Property(Name:output)

Last 1024 characters of the job output for the last step of the most recent job execution.

String

Complex Response Properties

The tables in this section provide property names, descriptions, and data types for the following complex properties returned in the response model to the query requests:

  • Oracle Management Service (OMS)

  • Database instance

Table 4–17 provides property names, descriptions, and data types for the Oracle Management Service. The type of the complex property is OMS.

Table 4-17 Oracle Management Service (OMS) Complex Property

Query Path Description Data Type

ComplexProperty(Type:oms).

Property(Name:name)

OMS name.

String

ComplexProperty(Type:oms).

Property(Name:status)

OMS service status (1 for up or 0 for down) for the OMS given by the peer "name" property.

Integer

ComplexProperty(Type:oms).

Property(Name:last error)

Time of the last OMS error as the number of milliseconds since January 1, 1970, 00:00:00 GMT, for the OMS given by the peer "name" property.

Number

ComplexProperty(Type:oms).

Property(Name:files pending load)

Number of files pending loading into the OMS for the OMS given by the peer "name" property.

Integer

ComplexProperty(Type:oms).

Property(Name:load directory)

Load directory of the OMS for the OMS given by the peer "name" property. The form of the directory path (path separator) is not specified further here.

String

ComplexProperty(Type:oms).

Property(Name:oldest load file)

Oldest file to load (in minutes) of the OMS for the OMS given by the peer "name" property.

Number

Table 4–18 provides property names, descriptions, and data types for the database instance. The type of the complex property is OMS.

Table 4-18 Database Instance Complex Property

Response Path Description Data Type

ComplexProperty(Type:database).

Property(Name:name)

Oracle database instance name.

String

ComplexProperty(Type:database).

Property(Name:type)

Oracle database instance type (one of oracle_database or rac_database).

String

Status Codes

The following tables provide status codes and descriptions for the following status types:

  • Enterprise Manager

  • Jobs

Table 4–19 describes the status codes for Enterprise Manager. You can use online help for a detailed description of Enterprise Manager target statuses. Enter Target Status as the keywords to search in online help, then select the topic About the Status Icons.

Table 4-19 Enterprise Manager Status Codes

Status Code Description

0

Target down

1

Target up

2

Metric error

3

Agent down

4

Unreachable

5

Blackout

6

Pending/unknown

Table 4–20 describes the status codes for jobs. You can use online help for a detailed description of Enterprise Manager job statuses. Enter Job Status as the keywords to search in online help, then select the topic About Job Status.

Table 4-20 Job Status Codes

Status Code Description

1

SCHEDULED — The execution is in a scheduled state.

2

RUNNING — The execution is running.

3

INITIALIZATION ERROR — The execution encountered an error and the remote process did not run.

4

FAILED — The execution failed.

5

SUCCEEDED — The execution succeeded.

6

SUSPENDED BY USER — A user suspended the execution.

7

SUSPENDED ON AGENT UNREACHABLE — The execution was suspended because the Agent was unreachable.

8

STOPPED — A user stopped the execution.

9

SUSPENDED ON LOCK — The execution is waiting for a lock on a shared resource.

10

SUSPENDED ON EVENT — The execution is waiting for an event to occur (usually for an Agent to bounce).

11

SUSPENDED ON BLACKOUT — The execution is suspended on a blackout.

12

STOP PENDING — The execution is in Stop Pending status waiting for some running steps to finish.

13

SUSPEND PENDING — The execution is in Suspend Pending status waiting for some running steps to finish.

14

Inactive (internal state).

15

Queued (internal state).

16

Failed retried (internal state).

18

SKIPPED — The execution was skipped and could not run, because the previous run of the job required too much time, or the Agent was unavailable for too long a period of time.

20

REASSIGNED — The execution is suspended because the original owner of the job was deleted and the job is not assigned to a new owner. The new owner must explicitly resume the job from the console.

21

SUSPENDED ON MISSING CREDENTIALS — The execution is suspended because some of the credentials needed for the job are not set.