The
getCrawl task retrieves a single crawl configuration.
The syntax for this task is:
cas-cmd getCrawl -id CrawlName [-f FileName.xml] [-h HostName] [-p PortNumber] [-d] [-l true|false]
Where:
-id(or--crawl_id) specifies the name of the crawl for which you want to retrieve the crawl configuration. Required.-f(or--file_name) specifies the XML output file to which you want to write the crawl configuration. Optional.-h(or--host) specifies the host where the CAS Service is running. If the flag is omitted, the default is the value of thecom.endeca.itl.cas.server.hostproperty incommandline.properties. If the property is not set, the value then defaults tolocalhost. Optional.-p(or--port) specifies the port of the CAS Service. If the flag is omitted, the default is the value of thecom.endeca.itl.cas.server.portproperty incommandline.properties. If the property is not set, the value then defaults to8500. Optional.-d(or--fill_in_defaults) specifies whether to populate the configuration file with the default values for unspecified properties. Optional.-l(or--isPortSsl) specifies whether to communicate with the service using an HTTPS connection. A value oftrueuses HTTPS and treats thecom.endeca.itl.cas.server.portproperty as an SSL port. A value offalseuses HTTP and treatscom.endeca.itl.cas.server.portas a non-SSL port. Specifyfalseif you enabled redirects from a non-SSL port to an SSL port. Optional.
The XML input and output files resulting from the
getAllCrawls and
createCrawls operations are similar to those from
getCrawl, except that
getAllCrawls returns a series of
<crawlConfig> elements because it pertains to
multiple crawls.
Crawls are retrieved without password values if there are any
configuration properties marked as
isPassword.
To get a crawl:
Start a command prompt and navigate to
<install path>\CAS\<version>\bin<install path>/CAS/<version>/binType
cas-cmd.bat(for Windows), orcas-cmd.sh(for UNIX) and specify thegetCrawltask with the id of the crawl for which to retrieve the configuration.Note
This task name is case sensitive.
Example 5. Example of getting a crawl
C:\Endeca\CAS\3.1.2\bin>cas-cmd getCrawl -id FileCrawl
<?xml version="1.0" encoding="UTF-8"?>
<configurations xmlns="http://endeca.com/itl/cas/2011-12">
<crawlConfig>
<crawlId>
<id>FileCrawl</id>
</crawlId>
<unavailableIncrementalSwitchesToFullCrawl>true</unavailableIncrementalSwitchesToFullCrawl>
<sourceConfig>
<moduleId>
<id>File System</id>
</moduleId>
<moduleProperties>
<moduleProperty>
<key>expandArchives</key>
<value>false</value>
</moduleProperty>
<moduleProperty>
<key>gatherNativeFileProperties</key>
<value>true</value>
</moduleProperty>
<moduleProperty>
<key>seeds</key>
<value>C:\tmp\itldocset</value>
<value>C:\tmp\iapdocset</value>
</moduleProperty>
</moduleProperties>
<excludeFilters/>
<includeFilters/>
</sourceConfig>
<textExtractionConfig>
<enabled>true</enabled>
<makeLocalCopy>false</makeLocalCopy>
</textExtractionConfig>
<manipulatorConfigs/>
<outputConfig>
<moduleId>
<id>Record Store</id>
</moduleId>
<moduleProperties/>
</outputConfig>
</crawlConfig>
</configurations>
