Module Expr Str ImportFrom alias Import alias Import alias Import alias Import alias Import alias Import alias Import alias Import alias Import alias Import alias identifier Assign NameStore ListLoad Str Assign NameStore Call AttributeLoad NameLoad attr NameLoad FunctionDef arguments args NameParam NameParam defaults body Expr Str Return Call NameLoad ListComp TupleLoad NameLoad NameLoad comprehension TupleStore NameStore NameStore Call AttributeLoad NameLoad attr NameLoad CompareIn NameLoad NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam defaults NameLoad body Expr Str If Call AttributeLoad NameLoad attr Str NameLoad body Expr Call AttributeLoad NameLoad attr Call AttributeLoad Str attr NameLoad Return NameLoad If CompareEq SubscriptLoad NameLoad Index Str Str body Assign NameStore Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr NameLoad Assign NameStore Dict Str Str Str Str SubscriptLoad NameLoad Index Str NameLoad NameLoad Str TryExcept body Expr Call AttributeLoad NameLoad attr NameLoad handlers ExceptHandler type NameLoad body Pass Return NameLoad If BoolOpOr NameLoad CompareEq Call AttributeLoad NameLoad attr Str Str body If CompareNotIn Str NameLoad body Assign SubscriptStore NameLoad Index Str Call AttributeLoad Str attr keyword Call AttributeLoad AttributeLoad NameLoad attr attr SubscriptLoad NameLoad Index Str keyword Call AttributeLoad NameLoad attr Str Str Assign NameStore Call AttributeLoad AttributeLoad NameLoad attr attr NameLoad Assign NameStore Dict Str Str Str Str Str SubscriptLoad NameLoad Index Str NameLoad NameLoad Call AttributeLoad NameLoad attr Str Str If Call NameLoad NameLoad NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad Assign NameStore Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr NameLoad TryExcept body Expr Call AttributeLoad NameLoad attr NameLoad handlers ExceptHandler type NameLoad body Pass Return NameLoad orelse TryExcept body Return Call AttributeLoad Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr NameLoad keyword NameLoad attr Dict Str Str Str Str NameLoad NameLoad NameLoad NameLoad Str handlers ExceptHandler type NameLoad body Assign TupleStore NameStore NameStore NameStore Call AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body Expr Str TryExcept body Assign NameStore Call AttributeLoad AttributeLoad AttributeLoad NameLoad attr attr attr Str keyword SubscriptLoad NameLoad Index Str keyword SubscriptLoad NameLoad Index Str keyword NameLoad keyword NameLoad Return Call AttributeLoad NameLoad attr NameLoad NameLoad handlers ExceptHandler type NameLoad body Assign TupleStore NameStore NameStore NameStore Call AttributeLoad NameLoad attr Assign NameStore Call AttributeLoad NameLoad attr NameLoad NameLoad NameLoad Expr Call AttributeLoad NameLoad attr NameLoad Return NameLoad decorator_list FunctionDef arguments args NameParam NameParam NameParam NameParam NameParam NameParam NameParam defaults NameLoad NameLoad NameLoad NameLoad NameLoad NameLoad kwarg body Expr Str Assign NameStore Dict If NameLoad body If Call NameLoad NameLoad NameLoad body Assign SubscriptStore NameLoad Index Str Call NameLoad NameLoad Call NameLoad AttributeLoad NameLoad attr orelse Assign SubscriptStore NameLoad Index Str Call NameLoad AttributeLoad NameLoad attr If NameLoad body If Call NameLoad NameLoad NameLoad body Assign SubscriptStore NameLoad Index Str Call NameLoad NameLoad NameLoad orelse Assign SubscriptStore NameLoad Index Str NameLoad If NameLoad body If Call NameLoad NameLoad NameLoad body Assign SubscriptStore NameLoad Index Str Call NameLoad NameLoad NameLoad orelse Assign SubscriptStore NameLoad Index Str NameLoad If NameLoad body Assign SubscriptStore NameLoad Index Str Call AttributeLoad NameLoad attr Str Str Assign SubscriptStore NameLoad Index Str Call AttributeLoad NameLoad attr Str If NameLoad body Expr Call AttributeLoad NameLoad attr NameLoad If Call NameLoad NameLoad AttributeLoad NameLoad attr body Expr Call AttributeLoad NameLoad attr NameLoad Return Call NameLoad NameLoad NameLoad keyword NameLoad decorator_list
N/A N/A 
Use the :doc:`Salt Event System </topics/event/index>` to fire events from the
master to the minion and vice-versa.
 __future__ absolute_import N/A collections N/A logging N/A os N/A sys N/A traceback N/A salt.crypt N/A salt.utils.event N/A salt.payload N/A salt.transport N/A salt.ext.six six N/A __proxyenabled__ N/A * N/A log N/A N/A logging getLogger __name__ _dict_subset N/A N/A keys master_dict N/A N/A N/A 
    Return a dictionary of only the subset of keys/values specified in keys
     N/A N/A dict N/A N/A k v N/A N/A k v N/A N/A six iteritems master_dict N/A k keys N/A fire_master N/A N/A data tag preload N/A None N/A N/A 
    Fire an event off up to the master server

    CLI Example:

    .. code-block:: bash

        salt '*' event.fire_master '{"data":"my event data"}' 'tag'
     N/A N/A N/A __opts__ get local None N/A N/A N/A N/A log warning N/A N/A Local mode detected. Event with tag {0} will NOT be sent. format tag N/A False N/A N/A N/A __opts__ N/A transport raet N/A N/A channel N/A N/A N/A N/A salt transport Channel factory __opts__ N/A load N/A id tag data cmd N/A __opts__ N/A id tag data _minion_event N/A N/A N/A N/A N/A channel send load N/A N/A N/A Exception N/A N/A N/A True N/A N/A preload N/A N/A N/A __opts__ get __cli salt-call N/A N/A N/A master_uri __opts__ N/A N/A N/A __opts__ N/A master_uri N/A N/A tcp://{ip}:{port} format ip N/A N/A N/A salt utils ip_bracket N/A __opts__ N/A interface port N/A N/A __opts__ get ret_port 4506 N/A auth N/A N/A N/A salt crypt SAuth __opts__ N/A load N/A id tag data tok cmd N/A __opts__ N/A id tag data N/A N/A auth gen_token salt _minion_event N/A N/A isinstance preload dict N/A N/A N/A N/A load update preload N/A channel N/A N/A N/A N/A salt transport Channel factory __opts__ N/A N/A N/A N/A N/A channel send load N/A N/A N/A Exception N/A N/A N/A True N/A N/A N/A N/A N/A N/A N/A N/A N/A N/A salt utils event MinionEvent __opts__ listen False fire_event N/A data tag events pretag data tag None None fire_master N/A N/A N/A Exception N/A N/A N/A exc_type exc_value exc_traceback N/A N/A sys exc_info N/A lines N/A N/A traceback format_exception exc_type exc_value exc_traceback N/A N/A N/A log debug lines N/A False N/A fire N/A N/A data tag N/A N/A N/A 
    Fire an event on the local minion event bus. Data must be formed as a dict.

    CLI Example:

    .. code-block:: bash

        salt '*' event.fire '{"data":"my event data"}' 'tag'
     N/A N/A N/A event N/A N/A N/A N/A salt utils event get_event minion sock_dir N/A __opts__ N/A sock_dir transport N/A __opts__ N/A transport opts __opts__ listen False N/A N/A N/A event fire_event data tag N/A N/A N/A Exception N/A N/A N/A exc_type exc_value exc_traceback N/A N/A sys exc_info N/A lines N/A N/A traceback format_exception exc_type exc_value exc_traceback N/A N/A N/A log debug lines N/A False N/A send N/A N/A tag data preload with_env with_grains with_pillar with_env_opts N/A None None False False False False kwargs N/A N/A 
    Send an event to the Salt Master

    .. versionadded:: 2014.7.0

    :param tag: A tag to give the event.
        Use slashes to create a namespace for related events. E.g.,
        ``myco/build/buildserver1/start``, ``myco/build/buildserver1/success``,
        ``myco/build/buildserver1/failure``.

    :param data: A dictionary of data to send in the event.
        This is free-form. Send any data points that are needed for whoever is
        consuming the event. Arguments on the CLI are interpreted as YAML so
        complex data structures are possible.

    :param with_env: Include environment variables from the current shell
        environment in the event data as ``environ``.. This is a short-hand for
        working with systems that seed the environment with relevant data such
        as Jenkins.
    :type with_env: Specify ``True`` to include all environment variables, or
        specify a list of strings of variable names to include.

    :param with_grains: Include grains from the current minion in the event
        data as ``grains``.
    :type with_grains: Specify ``True`` to include all grains, or specify a
        list of strings of grain names to include.

    :param with_pillar: Include Pillar values from the current minion in the
        event data as ``pillar``. Remember Pillar data is often sensitive data
        so be careful. This is useful for passing ephemeral Pillar values
        through an event. Such as passing the ``pillar={}`` kwarg in
        :py:func:`state.sls <salt.modules.state.sls>` from the Master, through
        an event on the Minion, then back to the Master.
    :type with_pillar: Specify ``True`` to include all Pillar values, or
        specify a list of strings of Pillar keys to include. It is a
        best-practice to only specify a relevant subset of Pillar data.

    :param with_env_opts: Include ``saltenv`` and ``pillarenv`` set on minion
        at the moment when event is send into event data.
    :type with_env_opts: Specify ``True`` to include ``saltenv`` and
        ``pillarenv`` values or ``False`` to omit them.

    :param kwargs: Any additional keyword arguments passed to this function
        will be interpreted as key-value pairs and included in the event data.
        This provides a convenient alternative to YAML for simple values.

    CLI Example:

    .. code-block:: bash

        salt-call event.send myco/mytag foo=Foo bar=Bar
        salt-call event.send 'myco/mytag' '{foo: Foo, bar: Bar}'

    A convenient way to allow Jenkins to execute ``salt-call`` is via sudo. The
    following rule in sudoers will allow the ``jenkins`` user to run only the
    following command.

    ``/etc/sudoers`` (allow preserving the environment):

    .. code-block:: text

        jenkins ALL=(ALL) NOPASSWD:SETENV: /usr/bin/salt-call event.send*

    Call Jenkins via sudo (preserve the environment):

    .. code-block:: bash

        sudo -E salt-call event.send myco/jenkins/build/success with_env=[BUILD_ID, BUILD_URL, GIT_BRANCH, GIT_COMMIT]

     N/A data_dict N/A N/A with_env N/A N/A N/A isinstance with_env list N/A N/A N/A data_dict N/A environ N/A _dict_subset with_env N/A dict N/A os environ N/A N/A N/A data_dict N/A environ N/A dict N/A os environ N/A with_grains N/A N/A N/A isinstance with_grains list N/A N/A N/A data_dict N/A grains N/A _dict_subset with_grains __grains__ N/A N/A N/A data_dict N/A grains __grains__ N/A with_pillar N/A N/A N/A isinstance with_pillar list N/A N/A N/A data_dict N/A pillar N/A _dict_subset with_pillar __pillar__ N/A N/A N/A data_dict N/A pillar __pillar__ N/A with_env_opts N/A N/A N/A data_dict N/A saltenv N/A N/A __opts__ get environment base N/A N/A data_dict N/A pillarenv N/A N/A __opts__ get pillarenv N/A kwargs N/A N/A N/A N/A data_dict update kwargs N/A N/A isinstance data N/A collections Mapping N/A N/A N/A N/A data_dict update data N/A N/A fire_master data_dict tag preload preload N/A