3 searchadmin Commands

This chapter describes the searchadmin commands. It contains these topics:

• Alphabetic List of searchadmin Commands

• Entering Special Characters

Alphabetic List of searchadmin Commands

A C D E G S U

A

activate identityPlugin
activate indexOptimizer
activate partitionConfig
activate schedule

C

create altWord
create docServiceInstance
create docServicePipeline
create facetTree
create proxyLogin
create schedule
create searchAttr
create source
create sourceGroup
create storageArea
create suggLink
create thesaurus
createAll altWord
createAll docServiceInstance
createAll docServicePipeline
createAll facetTree
createAll proxyLogin
createAll schedule
createAll searchAttr
createAll source
createAll sourceGroup
createAll storageArea
createAll suggLink

D

deactivate identityPlugin
deactivate indexOptimizer
deactivate schedule
delete creatable_type
deleteAll creatable_type
deleteList creatable_type

E

export creatable_type
export universal_type
exportAll creatable_type
exportList creatable_type

G

getAllObjectKeys
getAPIVersion
getAllStates identityPlugin
getAllStates schedule
getState identityPlugin
getState index
getState indexOptimizer
getState partitionConfig
getState schedule
getStateList identityPlugin
getStateList schedule

S

start indexOptimizer
start schedule
stop schedule

U

update altWord
update crawlerSettings
update docServiceInstance
update docServicePipeline
update globalBoundaryRules
update globalDocumentTypes
update index
update indexOptimizer
update partitionConfig
update proxyLogin
update queryConfig
update relevanceRanking
update schedule
update searchAttr
update source
update sourceGroup
update storageArea
update suggLink
update thesaurus
updateAll altWord
updateAll docServiceInstance
updateAll docServicePipeline
updateAll proxyLogin
updateAll schedule
updateAll searchAttr
updateAll source
updateAll sourceGroup
updateAll storageArea
updateAll suggLink

Entering Special Characters

To enter special characters as part of a command, you may have to enclose the value in quotes, or precede the character with backslashes as an escape, or both.

• Enclose values containing spaces in quotes, such as --NAME="Special Collection".

• To use the percent (%) and underscore (_) wildcard characters as literals for key patterns in operations such as createAll and deleteAll, escape the character with two backslashes, such as --NAME=web\\_source for an object named web_source. In single job mode, also enclose the values containing these characters in quotes, such as --NAME="web\\_source". Otherwise, the underscore matches any single character.

• Because a backslash is an escape character, you must use two backslashes to enter one backslash as a literal. For example, enter a Windows file path such as C:\\templates\\query.ftl.

• When using the short form for arguments, escape literal values starting with a dash with two backslashes in single job mode, such as -n \\-mysource. In session mode, enclose the values in quotes or escape the dash with one backslash. For example, -n \-mysource or -n "-mysource". Alternatively, use the long form for arguments, such as --NAME=-mysource.

See "Command Interface" for a discussion of session mode and single job mode.