Module for managing the Salt beacons on a minion
New in version 2015.8.0.
salt.modules.beacons.add(name, beacon_data, **kwargs)¶Add a beacon on the minion
| Parameters: |
|
|---|---|
| Returns: | Boolean and status message on success or failure of add. |
CLI Example:
salt '*' beacons.add ps "[{'salt-master': 'stopped'}, {'apache2': 'stopped'}]"
salt.modules.beacons.delete(name, **kwargs)¶Delete a beacon item
| Parameters: | name – Name of the beacon to delete |
|---|---|
| Returns: | Boolean and status message on success or failure of delete. |
CLI Example:
salt '*' beacons.delete ps
salt '*' beacons.delete load
salt.modules.beacons.disable(**kwargs)¶Disable all beaconsd jobs on the minion
| Returns: | Boolean and status message on success or failure of disable. |
|---|
CLI Example:
salt '*' beacons.disable
salt.modules.beacons.disable_beacon(name, **kwargs)¶Disable beacon on the minion
| Name: | Name of the beacon to disable. |
|---|---|
| Returns: | Boolean and status message on success or failure of disable. |
CLI Example:
salt '*' beacons.disable_beacon ps
salt.modules.beacons.enable(**kwargs)¶Enable all beacons on the minion
| Returns: | Boolean and status message on success or failure of enable. |
|---|
CLI Example:
salt '*' beacons.enable
salt.modules.beacons.enable_beacon(name, **kwargs)¶Enable beacon on the minion
| Name: | Name of the beacon to enable. |
|---|---|
| Returns: | Boolean and status message on success or failure of enable. |
CLI Example:
salt '*' beacons.enable_beacon ps
salt.modules.beacons.list_(return_yaml=True, include_pillar=True, include_opts=True)¶List the beacons currently configured on the minion
| Parameters: |
|
|---|---|
| Returns: | List of currently configured Beacons. |
CLI Example:
salt '*' beacons.list
salt.modules.beacons.list_available(return_yaml=True)¶List the beacons currently available on the minion
| Parameters: | return_yaml – Whether to return YAML formatted output, default True |
|---|---|
| Returns: | List of currently configured Beacons. |
CLI Example:
salt '*' beacons.list_available
salt.modules.beacons.modify(name, beacon_data, **kwargs)¶Modify an existing beacon
| Parameters: |
|
|---|---|
| Returns: | Boolean and status message on success or failure of modify. |
CLI Example:
salt '*' beacons.modify ps "[{'salt-master': 'stopped'}, {'apache2': 'stopped'}]"
salt.modules.beacons.reset(**kwargs)¶Resest beacon configuration on the minion
CLI Example:
salt '*' beacons.reset
salt.modules.beacons.save()¶Save all beacons on the minion
| Returns: | Boolean and status message on success or failure of save. |
|---|
CLI Example:
salt '*' beacons.save
Docs for previous releases are available on readthedocs.org.
Latest Salt release: 2018.3.3