salt.modules.openbsdrcctl

The rcctl service module for OpenBSD

salt.modules.openbsdrcctl.available(name)

Return True if the named service is available.

CLI Example:

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

Disable the named service to not start at boot.

CLI Example:

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

Return True if the named service is disabled at boot, False otherwise.

CLI Example:

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

Enable the named service to start at boot.

flags : None
Set optional flags to run the service with.

service.flags can be used to change the default flags.

CLI Example:

salt '*' service.enable <service name>
salt '*' service.enable <service name> flags=<flags>
salt.modules.openbsdrcctl.enabled(name, **kwargs)

Return True if the named service is enabled at boot and the provided flags match the configured ones (if any). Return False otherwise.

name
Service name

CLI Example:

salt '*' service.enabled <service name>
salt '*' service.enabled <service name> flags=<flags>
salt.modules.openbsdrcctl.get_all()

Return all installed services.

CLI Example:

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

Return what services are available but not enabled to start at boot.

CLI Example:

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

Return what services are set to run on boot.

CLI Example:

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

The inverse of service.available. Return True if the named service is not available.

CLI Example:

salt '*' service.missing sshd
salt.modules.openbsdrcctl.reload(name)

Reload the named service.

CLI Example:

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

Restart the named service.

CLI Example:

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

Start the named service.

CLI Example:

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

Return the status for a service, returns a bool whether the service is running.

CLI Example:

salt '*' service.status <service name>
salt.modules.openbsdrcctl.stop(name)

Stop the named service.

CLI Example:

salt '*' service.stop <service name>