salt.modules.openbsdservice#

The service module for OpenBSD

Important

If you feel that Salt should be using this module to manage services on a minion, and it is using a different module (or gives an error similar to 'service.start' is not available), see here.

salt.modules.openbsdservice.available(name)#

New in version 2014.7.0.

Returns True if the specified service is available, otherwise returns False.

CLI Example:

salt '*' service.available sshd
salt.modules.openbsdservice.disabled(name)#

New in version 2014.7.0.

Return True if the named service is disabled, false otherwise

CLI Example:

salt '*' service.disabled <service name>
salt.modules.openbsdservice.enabled(name, **kwargs)#

New in version 2014.7.0.

Return True if the named service is enabled, false otherwise

CLI Example:

salt '*' service.enabled <service name>
salt.modules.openbsdservice.get_all()#

New in version 2014.7.0.

Return all available boot services

CLI Example:

salt '*' service.get_all
salt.modules.openbsdservice.get_disabled()#

New in version 2014.7.0.

Return a set of services that are installed but disabled

CLI Example:

salt '*' service.get_disabled
salt.modules.openbsdservice.get_enabled()#

New in version 2014.7.0.

Return a list of service that are enabled on boot

CLI Example:

salt '*' service.get_enabled
salt.modules.openbsdservice.missing(name)#

New in version 2014.7.0.

The inverse of service.available. Returns True if the specified service is not available, otherwise returns False.

CLI Example:

salt '*' service.missing sshd
salt.modules.openbsdservice.reload_(name)#

New in version 2014.7.0.

Reload the named service

CLI Example:

salt '*' service.reload <service name>
salt.modules.openbsdservice.restart(name)#

Restart the named service

CLI Example:

salt '*' service.restart <service name>
salt.modules.openbsdservice.start(name)#

Start the specified service

CLI Example:

salt '*' service.start <service name>
salt.modules.openbsdservice.status(name, sig=None)#

Return the status for a service. If the name contains globbing, a dict mapping service name to True/False values is returned.

Changed in version 2018.3.0: The service name can now be a glob (e.g. salt*)

Parameters:

  • name (str) -- The name of the service to check

  • sig (str) -- Signature to use to find the service via ps

Returns:

True if running, False otherwise dict: Maps service name to True if running, False otherwise

Return type:

bool

CLI Example:

salt '*' service.status <service name> [service signature]
salt.modules.openbsdservice.stop(name)#

Stop the specified service

CLI Example:

salt '*' service.stop <service name>