# salt.states.beacon

## Management of the Salt beacons

Added in version 2015.8.0.

    ps:
      beacon.present:
        - save: True
        - enable: False
        - services:
            salt-master: running
            apache2: stopped

    sh:
      beacon.present: []

    load:
      beacon.present:
        - averages:
            1m:
              - 0.0
              - 2.0
            5m:
              - 0.0
              - 1.5
            15m:
              - 0.1
              - 1.0

    .. versionadded:: 3000

    Beginning in the 3000 release, multiple copies of a beacon can be configured
    using the ``beacon_module`` parameter.

    inotify_infs:
      beacon.present:
        - save: True
        - enable: True
        - files:
           /etc/infs.conf:
             mask:
               - create
               - delete
               - modify
             recurse: True
             auto_add: True
        - interval: 10
        - beacon_module: inotify
        - disable_during_state_run: True

    inotify_ntp:
      beacon.present:
        - save: True
        - enable: True
        - files:
           /etc/ntp.conf:
             mask:
               - create
               - delete
               - modify
             recurse: True
             auto_add: True
        - interval: 10
        - beacon_module: inotify
        - disable_during_state_run: True

salt.states.beacon.absent(name, save=False, **kwargs)

  Ensure beacon is absent.

  name

    The name of the beacon that is ensured absent.

  save

    True/False, if True the beacons.conf file be updated too. Default is False.

  Example:

      remove_beacon:
        beacon.absent:
          - name: ps
          - save: True

salt.states.beacon.disabled(name, **kwargs)

  Disable a beacon.

  name

    The name of the beacon to disable.

  Example:

      disable_beacon:
        beacon.disabled:
          - name: psp

salt.states.beacon.enabled(name, **kwargs)

  Enable a beacon.

  name

    The name of the beacon to enable.

  Example:

      enable_beacon:
        beacon.enabled:
          - name: ps

salt.states.beacon.present(name, save=False, **kwargs)

  Ensure beacon is configured with the included beacon data.

  name

    The name of the beacon to ensure is configured.

  save

    True/False, if True the beacons.conf file be updated too. Default is False.

  Example:

      ps_beacon:
        beacon.present:
          - name: ps
          - save: True
          - enable: False
          - services:
              salt-master: running
              apache2: stopped