Module for managing the Salt beacons on a minion
New in version 2015.8.0.
Add a beacon on the minion
Parameters: |
|
---|---|
Returns: |
Boolean and status message on success or failure of add. |
CLI Example:
salt '*' beacons.add ps "[{'processes': {'salt-master': 'stopped', 'apache2': 'stopped'}}]"
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
Disable all beacons jobs on the minion
Returns: | Boolean and status message on success or failure of disable. |
---|
CLI Example:
salt '*' beacons.disable
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
Enable all beacons on the minion
Returns: | Boolean and status message on success or failure of enable. |
---|---|
Return type: | bool |
CLI Example:
salt '*' beacons.enable
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
List the beacons currently configured on the minion
Parameters: |
|
---|---|
Returns: |
List of currently configured Beacons. |
CLI Example:
salt '*' beacons.list
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
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'}]"
Resest beacon configuration on the minion
CLI Example:
salt '*' beacons.reset
Save all beacons on the minion
Returns: | Boolean and status message on success or failure of save. |
---|
CLI Example:
salt '*' beacons.save
© 2019 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.beacons.html