salt.modules.netbsdservice

The service module for NetBSD

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.netbsdservice.available(name)

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

CLI Example:

salt '*' service.available sshd
salt.modules.netbsdservice.disable(name, **kwargs)

Disable the named service to start at boot

CLI Example:

salt '*' service.disable <service name>
salt.modules.netbsdservice.disabled(name)

Return True if the named service is enabled, false otherwise

CLI Example:

salt '*' service.disabled <service name>
salt.modules.netbsdservice.enable(name, **kwargs)

Enable the named service to start at boot

CLI Example:

salt '*' service.enable <service name>
salt.modules.netbsdservice.enabled(name, **kwargs)

Return True if the named service is enabled, false otherwise

CLI Example:

salt '*' service.enabled <service name>
salt.modules.netbsdservice.force_reload(name)

Force-reload the named service

CLI Example:

salt '*' service.force_reload <service name>
salt.modules.netbsdservice.get_all()

Return all available boot services

CLI Example:

salt '*' service.get_all
salt.modules.netbsdservice.get_disabled()

Return a set of services that are installed but disabled

CLI Example:

salt '*' service.get_disabled
salt.modules.netbsdservice.get_enabled()

Return a list of service that are enabled on boot

CLI Example:

salt '*' service.get_enabled
salt.modules.netbsdservice.missing(name)

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.netbsdservice.reload(name)

Reload the named service

CLI Example:

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

Restart the named service

CLI Example:

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

Start the specified service

CLI Example:

salt '*' service.start <service name>
salt.modules.netbsdservice.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 Oxygen: 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.netbsdservice.stop(name)

Stop the specified service

CLI Example:

salt '*' service.stop <service name>