This chapter describes the searchadmin
commands. It contains these topics:
activate clustering activate clusterTree activate identityPlugin activate indexOptimizer activate resultList activate schedule activate skinBundle activate spaceCalculator
create altWord create clusterTree create identityPlugin create proxyLogin create schedule create searchAttr create skinBundle create source create sourceGroup create sourceType create storageArea create suggLink create thesaurus createAll altWord createAll clusterTree createAll identityPlugin createAll proxyLogin createAll schedule createAll searchAttr createAll source createAll sourceGroup createAll sourceType createAll storageArea createAll suggLink
deactivate clustering deactivate clusterTree deactivate identityPlugin deactivate indexOptimizer deactivate resultList deactivate schedule deactivate skinBundle deactivate spaceCalculator delete creatable_type deleteAll creatable_type deleteList creatable_type
export creatable_type export universal_type exportAll creatable_type exportList creatable_type
getAllObjectKeys getAPIVersion getAllStates clusterTree getAllStates identityPlugin getAllStates schedule getAllStates skinBundle getState clustering getState clusterTree getState identityPlugin getState index getState indexOptimizer getState resultList getState schedule getState skinBundle getState spaceCalculator getState task getStateList clusterTree getStateList identityPlugin getStateList schedule getStateList skinBundle
start indexOptimizer start schedule start task stop schedule start spaceCalculator
update alert update altWord update clustering update clusterTree update crawlerSettings update index update indexOptimizer update partitionConfig update proxyLogin update queryConfig update resultList update schedule update searchAttr update skinBundle update source update sourceGroup update sourceType update spaceCalculator update storageArea update suggLink update thesaurus updateAll alert updateAll altWord updateAll clusterTree updateAll proxyLogin updateAll schedule updateAll searchAttr updateAll source updateAll sourceGroup updateAll sourceType updateAll suggLink
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.
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.