salt.returners.couchbase_return
Simple returner for Couchbase. Optional configuration settings are listed below, along with sane defaults.
couchbase.host: 'salt' couchbase.port: 8091 couchbase.bucket: 'salt' couchbase.ttl: 24 couchbase.password: 'password' couchbase.skip_verify_views: False
To use the couchbase returner, append '--return couchbase' to the salt command. ex:
salt '*' test.ping --return couchbase
To use the alternative configuration, append '--return_config alternative' to the salt command.
New in version 2015.5.0.
salt '*' test.ping --return couchbase --return_config alternative
To override individual configuration items, append --return_kwargs '{"key:": "value"}' to the salt command.
New in version 2016.3.0.
salt '*' test.ping --return couchbase --return_kwargs '{"bucket": "another-salt"}' All of the return data will be stored in documents as follows:
JID
load: load obj tgt_minions: list of minions targeted nocache: should we not cache the return data
JID/MINION_ID
return: return_data full_ret: full load of job return
-
Return the information returned when the specified job id was executed
salt.returners.couchbase_return.get_jid(jid)
-
Return a list of all job ids
salt.returners.couchbase_return.get_jids()
-
Return the load data that marks a specified jid
salt.returners.couchbase_return.get_load(jid)
-
Return a job id and prepare the job id directory This is the function responsible for making sure jids don't collide (unless its passed a jid) So do what you have to do to make sure that stays the case
salt.returners.couchbase_return.prep_jid(nocache=False, passed_jid=None)
-
Return data to couchbase bucket
salt.returners.couchbase_return.returner(load)
-
Save the load to the specified jid
salt.returners.couchbase_return.save_load(jid, clear_load, minion=None)
-
Save/update the minion list for a given jid. The syndic_id argument is included for API compatibility only.
salt.returners.couchbase_return.save_minions(jid, minions, syndic_id=None)
© 2021 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltproject.io/en/latest/ref/returners/all/salt.returners.couchbase_return.html