salt.modules.freebsdservice

The service module for FreeBSD

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.freebsdservice.available(name, jail=None)

Check that the given service is available.

Changed in version 2016.3.4.

jail: optional jid or jail name

CLI Example:

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

Disable the named service to start at boot

Arguments the same as for enable()

Changed in version 2016.3.4.

jail (optional keyword argument)
the jail's id or name
chroot (optional keyword argument)
the jail's chroot, if the jail's /etc is not mounted read-write

CLI Example:

salt '*' service.disable <service name>
salt.modules.freebsdservice.disabled(name, **kwargs)

Return True if the named service is enabled, false otherwise

CLI Example:

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

Enable the named service to start at boot

name
service name
config
: /etc/rc.conf

Config file for managing service. If config value is empty string, then /etc/rc.conf.d/<service> used. See man rc.conf(5) for details.

Also service.config variable can be used to change default.

Changed in version 2016.3.4.

jail (optional keyword argument)
the jail's id or name
chroot (optional keyword argument)
the jail's chroot, if the jail's /etc is not mounted read-write

CLI Example:

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

Return True if the named service is enabled, false otherwise

name
Service name

Changed in version 2016.3.4.

Support for jail (representing jid or jail name) keyword argument in kwargs

CLI Example:

salt '*' service.enabled <service name>
salt.modules.freebsdservice.get_all(jail=None)

Return a list of all available services

Changed in version 2016.3.4.

jail: optional jid or jail name

CLI Example:

salt '*' service.get_all
salt.modules.freebsdservice.get_disabled(jail=None)

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

Changed in version 2016.3.4.

Support for jail (representing jid or jail name) keyword argument in kwargs

CLI Example:

salt '*' service.get_disabled
salt.modules.freebsdservice.get_enabled(jail=None)

Return what services are set to run on boot

Changed in version 2016.3.4.

Support for jail (representing jid or jail name) keyword argument in kwargs

CLI Example:

salt '*' service.get_enabled
salt.modules.freebsdservice.missing(name, jail=None)

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

Changed in version 2016.3.4.

jail: optional jid or jail name

CLI Example:

salt '*' service.missing sshd
salt.modules.freebsdservice.reload(name, jail=None)

Restart the named service

Changed in version 2016.3.4.

jail: optional jid or jail name

CLI Example:

salt '*' service.reload <service name>
salt.modules.freebsdservice.restart(name, jail=None)

Restart the named service

Changed in version 2016.3.4.

jail: optional jid or jail name

CLI Example:

salt '*' service.restart <service name>
salt.modules.freebsdservice.start(name, jail=None)

Start the specified service

Changed in version 2016.3.4.

jail: optional jid or jail name

CLI Example:

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

Return the status for a service (True or False).

name
Name of service

Changed in version 2016.3.4.

jail: optional jid or jail name

CLI Example:

salt '*' service.status <service name>
salt.modules.freebsdservice.stop(name, jail=None)

Stop the specified service

Changed in version 2016.3.4.

jail: optional jid or jail name

CLI Example:

salt '*' service.stop <service name>