salt.runners.saltutil

The Saltutil runner is used to sync custom types to the Master. See the saltutil module for documentation on managing updates to minions.

salt.runners.saltutil.sync_all(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

Sync all custom types

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

dictionary of modules to sync based on type

extmod_blacklist : None

dictionary of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_all
salt-run saltutil.sync_all extmod_whitelist={'runners': ['custom_runner'], 'grains': []}

salt.runners.saltutil.sync_cache(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

New in version 2017.7.0.

Sync cache modules from salt://_cache to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_cache

salt.runners.saltutil.sync_clouds(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

New in version 2017.7.0.

Sync cloud modules from salt://_clouds to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_clouds

salt.runners.saltutil.sync_eauth_tokens(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

New in version 2018.3.0.

Sync eauth token modules from salt://_tokens to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_eauth_tokens

salt.runners.saltutil.sync_engines(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

Sync engines from salt://_engines to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_engines

salt.runners.saltutil.sync_executors(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

New in version 2019.2.1.

Sync executor modules from salt://_executors to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_executors

salt.runners.saltutil.sync_fileserver(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

New in version 2018.3.0.

Sync fileserver modules from salt://_fileserver to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_fileserver

salt.runners.saltutil.sync_grains(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

Sync grains modules from salt://_grains to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_grains

salt.runners.saltutil.sync_modules(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

Sync execution modules from salt://_modules to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_modules

salt.runners.saltutil.sync_output(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

Sync output modules from salt://_output to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_output

salt.runners.saltutil.sync_pillar(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

Sync pillar modules from salt://_pillar to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_pillar

salt.runners.saltutil.sync_proxymodules(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

Sync proxy modules from salt://_proxy to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_proxy

salt.runners.saltutil.sync_queues(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

Sync queue modules from salt://_queues to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_queues

salt.runners.saltutil.sync_renderers(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

Sync renderer modules from from salt://_renderers to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_renderers

salt.runners.saltutil.sync_returners(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

Sync returner modules from salt://_returners to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_returners

salt.runners.saltutil.sync_roster(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

New in version 2017.7.0.

Sync roster modules from salt://_roster to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_roster

salt.runners.saltutil.sync_runners(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

Sync runners from salt://_runners to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_runners

salt.runners.saltutil.sync_sdb(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

New in version 2017.7.0.

Sync sdb modules from salt://_sdb to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_sdb

salt.runners.saltutil.sync_serializers(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

New in version 2019.2.0.

Sync serializer modules from salt://_serializers to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_utils

salt.runners.saltutil.sync_states(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

Sync state modules from salt://_states to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_states

salt.runners.saltutil.sync_thorium(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

New in version 2018.3.0.

Sync Thorium from salt://_thorium to the master

saltenv: base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist

comma-seperated list of modules to sync

extmod_blacklist

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_thorium

salt.runners.saltutil.sync_tops(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

New in version 2016.3.7,2016.11.4,2017.7.0.

Sync master_tops modules from salt://_tops to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

CLI Example:

salt-run saltutil.sync_tops

salt.runners.saltutil.sync_utils(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

New in version 2016.11.0.

Sync utils modules from salt://_utils to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_utils

salt.runners.saltutil.sync_wheel(saltenv='base', extmod_whitelist=None, extmod_blacklist=None)

Sync wheel modules from salt://_wheel to the master

saltenv : base

The fileserver environment from which to sync. To sync from more than one environment, pass a comma-separated list.

extmod_whitelist : None

comma-seperated list of modules to sync

extmod_blacklist : None

comma-seperated list of modules to blacklist based on type

CLI Example:

salt-run saltutil.sync_wheel