Skip Headers
Oracle® Secure Enterprise Search Administration API Guide
11g Release 1 (11.1.2.0.0)

E14133-02
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

getAllStates schedule

Returns the current state of all schedules as an XML document.

See Also

getState schedule
getStateList schedule

Syntax

getAllStates schedule [--OUTPUT_FILE=output_file] [--PROPERTY_LIST=state_property] [key_pattern...]

or

getAllStates schedule [-o output_file] [-l state_property] [key_pattern...]

Parameters

output_file

Name of a file in which the exported XML document is stored. You can specify a simple file name, a relative path, or a fully qualified path. When executing on multiple instances, the getAllStates command creates a separate file for each one and appends the host name and port number to the base name.

state_properties

List of one or more state properties: lastCrawled, logFilePath, nextCrawl, scheduleError, or status. Separate multiple properties with commas. All state properties are returned by default.

key_pattern

Object key that specifies a subset of objects to process in the format key=value. The value can include wildcard characters:

  • A percent sign (%) matches zero or more characters. In a multibyte character set, it matches zero or more bytes.

  • An underscore (_) matches one character. In a multibyte character set, it matches one byte.

Example

This example uses the percent (%) wildcard character to find the Doc Library schedule and requests two status properties. The status is currently SCHEDULED and the next crawl is MANUAL.

SES>getAllStates schedule --NAME=Doc% --PROPERTY_LIST=status,nextCrawl
 
<?xml version="1.0" encoding="UTF-8"?>
<search:state productVersion="11.1.2.0.0" xmlns:search="http://xmlns.oracle.com/search">
   <search:objectStates>
      <search:objectState>
         <search:objectType>schedule</search:objectType>
         <search:objectKey>
            <search:keyPairs>
               <search:keyPair>
                  <search:name>name</search:name>
                  <search:value>Doc Library</search:value>
               </search:keyPair>
            </search:keyPairs>
         </search:objectKey>
         <search:stateProperties>
            <search:stateProperty>
               <search:propertyName>status</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>SCHEDULED</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
            <search:stateProperty>
               <search:propertyName>nextCrawl</search:propertyName>
               <search:propertyValues>
                  <search:propertyValue>
                     <search:value>MANUAL</search:value>
                  </search:propertyValue>
               </search:propertyValues>
            </search:stateProperty>
         </search:stateProperties>
      </search:objectState>
   </search:objectStates>
</search:state>