# salt.modules.solrcloud

Module for solrcloud configuration

Added in version 2017.7.0.

For now, module is limited to http-exposed API. It doesn't implement config upload via Solr zkCli

salt.modules.solrcloud.BOOL_PROPS_LIST = ['transient', 'loadOnStartup']

  Collections options type definition Reference: https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-api1

salt.modules.solrcloud.DICT_OPTIONS_LIST = ['properties']

  Collection unmodifiable options Reference: https://cwiki.apache.org/confluence/display/solr/Collections+API#CollectionsAPI-modifycoll

salt.modules.solrcloud.alias_exists(alias_name, **kwargs)

  Check alias existence

  Additional parameters (kwargs) may be passed, they will be proxied to http.query

  CLI Example:

      salt '*' solrcloud.alias_exists my_alias

salt.modules.solrcloud.alias_get_collections(alias_name, **kwargs)

  Get collection list for an alias

  Additional parameters (kwargs) may be passed, they will be proxied to http.query

  CLI Example:

      salt '*' solrcloud.alias_get my_alias

salt.modules.solrcloud.alias_set_collections(alias_name, collections=None, **kwargs)

  Define an alias

  Additional parameters (kwargs) may be passed, they will be proxied to http.query

  CLI Example:

      salt '*' solrcloud.alias_set my_alias collections=[collection1, colletion2]

salt.modules.solrcloud.cluster_status(**kwargs)

  Get cluster status

  Additional parameters (kwargs) may be passed, they will be proxied to http.query

  CLI Example:

      salt '*' solrcloud.cluster_status

salt.modules.solrcloud.collection_backup(collection_name, location, backup_name=None, **kwargs)

  Create a backup for a collection.

  Additional parameters (kwargs) may be passed, they will be proxied to http.query

  CLI Example:

      salt '*' solrcloud.core_backup collection_name /mnt/nfs_backup

salt.modules.solrcloud.collection_backup_all(location, backup_name=None, **kwargs)

  Create a backup for all collection present on the server.

  Additional parameters (kwargs) may be passed, they will be proxied to http.query

  CLI Example:

      salt '*' solrcloud.core_backup /mnt/nfs_backup

salt.modules.solrcloud.collection_check_options(options)

  Check collections options

  CLI Example:

      salt '*' solrcloud.collection_check_options '{"replicationFactor":4}'

salt.modules.solrcloud.collection_create(collection_name, options=None, **kwargs)

  Create a collection,

  Additional parameters (kwargs) may be passed, they will be proxied to http.query

  CLI Example:

      salt '*' solrcloud.collection_create collection_name

  Collection creation options may be passed using the "options" parameter. Do not include option "name" since it already specified by the mandatory parameter "collection_name"

      salt '*' solrcloud.collection_create collection_name options={"replicationFactor":2, "numShards":3}

  Cores options may be passed using the "properties" key in options. Do not include property "name"

      salt '*' solrcloud.collection_create collection_name options={"replicationFactor":2, "numShards":3,             "properties":{"dataDir":"/srv/solr/hugePartitionSollection"}}

salt.modules.solrcloud.collection_creation_options()

  Get collection option list that can only be defined at creation

  CLI Example:

      salt '*' solrcloud.collection_creation_options

salt.modules.solrcloud.collection_exists(collection_name, **kwargs)

  Check if a collection exists

  Additional parameters (kwargs) may be passed, they will be proxied to http.query

  CLI Example:

      salt '*' solrcloud.collection_exists collection_name

salt.modules.solrcloud.collection_get_options(collection_name, **kwargs)

  Get collection options

  Additional parameters (kwargs) may be passed, they will be proxied to http.query

  CLI Example:

      salt '*' solrcloud.collection_get_options collection_name

salt.modules.solrcloud.collection_list(**kwargs)

  List all collections

  Additional parameters (kwargs) may be passed, they will be proxied to http.query

  CLI Example:

      salt '*' solrcloud.collection_list

salt.modules.solrcloud.collection_reload(collection, **kwargs)

  Check if a collection exists

  Additional parameters (kwargs) may be passed, they will be proxied to http.query

  CLI Example:

      salt '*' solrcloud.collection_reload collection_name

salt.modules.solrcloud.collection_set_options(collection_name, options, **kwargs)

  Change collection options

  Additional parameters (kwargs) may be passed, they will be proxied to http.query

  Note that not every parameter can be changed after collection creation

  CLI Example:

      salt '*' solrcloud.collection_set_options collection_name options={"replicationFactor":4}

salt.modules.solrcloud.log = <SaltLoggingClass salt.modules.solrcloud (GARBAGE)>

  Core properties type definition. Reference: https://cwiki.apache.org/confluence/display/solr/Defining+core.properties