repo
stringclasses
85 values
path
stringlengths
8
121
func_name
stringlengths
1
82
original_string
stringlengths
112
65.5k
language
stringclasses
1 value
code
stringlengths
112
65.5k
code_tokens
listlengths
20
4.09k
docstring
stringlengths
3
46.3k
docstring_tokens
listlengths
1
564
sha
stringclasses
85 values
url
stringlengths
93
218
partition
stringclasses
1 value
saltstack/salt
salt/modules/mac_keychain.py
install
def install(cert, password, keychain="/Library/Keychains/System.keychain", allow_any=False, keychain_password=None): ''' Install a certificate cert The certificate to install password The password for the certificate being installed forma...
python
def install(cert, password, keychain="/Library/Keychains/System.keychain", allow_any=False, keychain_password=None): ''' Install a certificate cert The certificate to install password The password for the certificate being installed forma...
[ "def", "install", "(", "cert", ",", "password", ",", "keychain", "=", "\"/Library/Keychains/System.keychain\"", ",", "allow_any", "=", "False", ",", "keychain_password", "=", "None", ")", ":", "if", "keychain_password", "is", "not", "None", ":", "unlock_keychain",...
Install a certificate cert The certificate to install password The password for the certificate being installed formatted in the way described for openssl command in the PASS PHRASE ARGUMENTS section. Note: The password given here will show up as plaintext in the job returned ...
[ "Install", "a", "certificate" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_keychain.py#L44-L88
train
saltstack/salt
salt/modules/mac_keychain.py
uninstall
def uninstall(cert_name, keychain="/Library/Keychains/System.keychain", keychain_password=None): ''' Uninstall a certificate from a keychain cert_name The name of the certificate to remove keychain The keychain to install the certificate to, this defaults to...
python
def uninstall(cert_name, keychain="/Library/Keychains/System.keychain", keychain_password=None): ''' Uninstall a certificate from a keychain cert_name The name of the certificate to remove keychain The keychain to install the certificate to, this defaults to...
[ "def", "uninstall", "(", "cert_name", ",", "keychain", "=", "\"/Library/Keychains/System.keychain\"", ",", "keychain_password", "=", "None", ")", ":", "if", "keychain_password", "is", "not", "None", ":", "unlock_keychain", "(", "keychain", ",", "keychain_password", ...
Uninstall a certificate from a keychain cert_name The name of the certificate to remove keychain The keychain to install the certificate to, this defaults to /Library/Keychains/System.keychain keychain_password If your keychain is likely to be locked pass the password and ...
[ "Uninstall", "a", "certificate", "from", "a", "keychain" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_keychain.py#L91-L121
train
saltstack/salt
salt/modules/mac_keychain.py
list_certs
def list_certs(keychain="/Library/Keychains/System.keychain"): ''' List all of the installed certificates keychain The keychain to install the certificate to, this defaults to /Library/Keychains/System.keychain CLI Example: .. code-block:: bash salt '*' keychain.list_cert...
python
def list_certs(keychain="/Library/Keychains/System.keychain"): ''' List all of the installed certificates keychain The keychain to install the certificate to, this defaults to /Library/Keychains/System.keychain CLI Example: .. code-block:: bash salt '*' keychain.list_cert...
[ "def", "list_certs", "(", "keychain", "=", "\"/Library/Keychains/System.keychain\"", ")", ":", "cmd", "=", "'security find-certificate -a {0} | grep -o \"alis\".*\\\\\" | '", "'grep -o \\'\\\\\"[-A-Za-z0-9.:() ]*\\\\\"\\''", ".", "format", "(", "_quote", "(", "keychain", ")", "...
List all of the installed certificates keychain The keychain to install the certificate to, this defaults to /Library/Keychains/System.keychain CLI Example: .. code-block:: bash salt '*' keychain.list_certs
[ "List", "all", "of", "the", "installed", "certificates" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_keychain.py#L124-L141
train
saltstack/salt
salt/modules/mac_keychain.py
get_friendly_name
def get_friendly_name(cert, password): ''' Get the friendly name of the given certificate cert The certificate to install password The password for the certificate being installed formatted in the way described for openssl command in the PASS PHRASE ARGUMENTS section N...
python
def get_friendly_name(cert, password): ''' Get the friendly name of the given certificate cert The certificate to install password The password for the certificate being installed formatted in the way described for openssl command in the PASS PHRASE ARGUMENTS section N...
[ "def", "get_friendly_name", "(", "cert", ",", "password", ")", ":", "cmd", "=", "'openssl pkcs12 -in {0} -passin pass:{1} -info -nodes -nokeys 2> /dev/null | '", "'grep friendlyName:'", ".", "format", "(", "_quote", "(", "cert", ")", ",", "_quote", "(", "password", ")",...
Get the friendly name of the given certificate cert The certificate to install password The password for the certificate being installed formatted in the way described for openssl command in the PASS PHRASE ARGUMENTS section Note: The password given here will show up as plaint...
[ "Get", "the", "friendly", "name", "of", "the", "given", "certificate" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_keychain.py#L144-L167
train
saltstack/salt
salt/modules/mac_keychain.py
get_default_keychain
def get_default_keychain(user=None, domain="user"): ''' Get the default keychain user The user to check the default keychain of domain The domain to use valid values are user|system|common|dynamic, the default is user CLI Example: .. code-block:: bash salt '*' keycha...
python
def get_default_keychain(user=None, domain="user"): ''' Get the default keychain user The user to check the default keychain of domain The domain to use valid values are user|system|common|dynamic, the default is user CLI Example: .. code-block:: bash salt '*' keycha...
[ "def", "get_default_keychain", "(", "user", "=", "None", ",", "domain", "=", "\"user\"", ")", ":", "cmd", "=", "\"security default-keychain -d {0}\"", ".", "format", "(", "domain", ")", "return", "__salt__", "[", "'cmd.run'", "]", "(", "cmd", ",", "runas", "...
Get the default keychain user The user to check the default keychain of domain The domain to use valid values are user|system|common|dynamic, the default is user CLI Example: .. code-block:: bash salt '*' keychain.get_default_keychain
[ "Get", "the", "default", "keychain" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_keychain.py#L170-L187
train
saltstack/salt
salt/modules/mac_keychain.py
set_default_keychain
def set_default_keychain(keychain, domain="user", user=None): ''' Set the default keychain keychain The location of the keychain to set as default domain The domain to use valid values are user|system|common|dynamic, the default is user user The user to set the default key...
python
def set_default_keychain(keychain, domain="user", user=None): ''' Set the default keychain keychain The location of the keychain to set as default domain The domain to use valid values are user|system|common|dynamic, the default is user user The user to set the default key...
[ "def", "set_default_keychain", "(", "keychain", ",", "domain", "=", "\"user\"", ",", "user", "=", "None", ")", ":", "cmd", "=", "\"security default-keychain -d {0} -s {1}\"", ".", "format", "(", "domain", ",", "keychain", ")", "return", "__salt__", "[", "'cmd.ru...
Set the default keychain keychain The location of the keychain to set as default domain The domain to use valid values are user|system|common|dynamic, the default is user user The user to set the default keychain as CLI Example: .. code-block:: bash salt '*' key...
[ "Set", "the", "default", "keychain" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_keychain.py#L190-L210
train
saltstack/salt
salt/modules/mac_keychain.py
get_hash
def get_hash(name, password=None): ''' Returns the hash of a certificate in the keychain. name The name of the certificate (which you can get from keychain.get_friendly_name) or the location of a p12 file. password The password that is used in the certificate. Only required if ...
python
def get_hash(name, password=None): ''' Returns the hash of a certificate in the keychain. name The name of the certificate (which you can get from keychain.get_friendly_name) or the location of a p12 file. password The password that is used in the certificate. Only required if ...
[ "def", "get_hash", "(", "name", ",", "password", "=", "None", ")", ":", "if", "'.p12'", "in", "name", "[", "-", "4", ":", "]", ":", "cmd", "=", "'openssl pkcs12 -in {0} -passin pass:{1} -passout pass:{1}'", ".", "format", "(", "name", ",", "password", ")", ...
Returns the hash of a certificate in the keychain. name The name of the certificate (which you can get from keychain.get_friendly_name) or the location of a p12 file. password The password that is used in the certificate. Only required if your passing a p12 file. Note: This wil...
[ "Returns", "the", "hash", "of", "a", "certificate", "in", "the", "keychain", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_keychain.py#L236-L265
train
saltstack/salt
salt/states/aws_sqs.py
exists
def exists( name, region, user=None, opts=False): ''' Ensure the SQS queue exists. name Name of the SQS queue. region Region to create the queue user Name of the user performing the SQS operations opts Include additional argumen...
python
def exists( name, region, user=None, opts=False): ''' Ensure the SQS queue exists. name Name of the SQS queue. region Region to create the queue user Name of the user performing the SQS operations opts Include additional argumen...
[ "def", "exists", "(", "name", ",", "region", ",", "user", "=", "None", ",", "opts", "=", "False", ")", ":", "ret", "=", "{", "'name'", ":", "name", ",", "'result'", ":", "True", ",", "'comment'", ":", "''", ",", "'changes'", ":", "{", "}", "}", ...
Ensure the SQS queue exists. name Name of the SQS queue. region Region to create the queue user Name of the user performing the SQS operations opts Include additional arguments and options to the aws command line
[ "Ensure", "the", "SQS", "queue", "exists", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/aws_sqs.py#L30-L70
train
saltstack/salt
salt/states/aws_sqs.py
absent
def absent( name, region, user=None, opts=False): ''' Remove the named SQS queue if it exists. name Name of the SQS queue. region Region to remove the queue from user Name of the user performing the SQS operations opts Include a...
python
def absent( name, region, user=None, opts=False): ''' Remove the named SQS queue if it exists. name Name of the SQS queue. region Region to remove the queue from user Name of the user performing the SQS operations opts Include a...
[ "def", "absent", "(", "name", ",", "region", ",", "user", "=", "None", ",", "opts", "=", "False", ")", ":", "ret", "=", "{", "'name'", ":", "name", ",", "'result'", ":", "True", ",", "'comment'", ":", "''", ",", "'changes'", ":", "{", "}", "}", ...
Remove the named SQS queue if it exists. name Name of the SQS queue. region Region to remove the queue from user Name of the user performing the SQS operations opts Include additional arguments and options to the aws command line
[ "Remove", "the", "named", "SQS", "queue", "if", "it", "exists", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/aws_sqs.py#L73-L112
train
saltstack/salt
setup.py
_parse_op
def _parse_op(op): ''' >>> _parse_op('>') 'gt' >>> _parse_op('>=') 'ge' >>> _parse_op('=>') 'ge' >>> _parse_op('=> ') 'ge' >>> _parse_op('<') 'lt' >>> _parse_op('<=') 'le' >>> _parse_op('==') 'eq' >>> _parse_op(' <= ') 'le' ''' op = op.strip() ...
python
def _parse_op(op): ''' >>> _parse_op('>') 'gt' >>> _parse_op('>=') 'ge' >>> _parse_op('=>') 'ge' >>> _parse_op('=> ') 'ge' >>> _parse_op('<') 'lt' >>> _parse_op('<=') 'le' >>> _parse_op('==') 'eq' >>> _parse_op(' <= ') 'le' ''' op = op.strip() ...
[ "def", "_parse_op", "(", "op", ")", ":", "op", "=", "op", ".", "strip", "(", ")", "if", "'>'", "in", "op", ":", "if", "'='", "in", "op", ":", "return", "'ge'", "else", ":", "return", "'gt'", "elif", "'<'", "in", "op", ":", "if", "'='", "in", ...
>>> _parse_op('>') 'gt' >>> _parse_op('>=') 'ge' >>> _parse_op('=>') 'ge' >>> _parse_op('=> ') 'ge' >>> _parse_op('<') 'lt' >>> _parse_op('<=') 'le' >>> _parse_op('==') 'eq' >>> _parse_op(' <= ') 'le'
[ ">>>", "_parse_op", "(", ">", ")", "gt", ">>>", "_parse_op", "(", ">", "=", ")", "ge", ">>>", "_parse_op", "(", "=", ">", ")", "ge", ">>>", "_parse_op", "(", "=", ">", ")", "ge", ">>>", "_parse_op", "(", "<", ")", "lt", ">>>", "_parse_op", "(", ...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/setup.py#L142-L175
train
saltstack/salt
setup.py
_parse_ver
def _parse_ver(ver): ''' >>> _parse_ver("'3.4' # pyzmq 17.1.0 stopped building wheels for python3.4") '3.4' >>> _parse_ver('"3.4"') '3.4' >>> _parse_ver('"2.6.17"') '2.6.17' ''' if '#' in ver: ver, _ = ver.split('#', 1) ver = ver.strip() return ver.strip('\'').st...
python
def _parse_ver(ver): ''' >>> _parse_ver("'3.4' # pyzmq 17.1.0 stopped building wheels for python3.4") '3.4' >>> _parse_ver('"3.4"') '3.4' >>> _parse_ver('"2.6.17"') '2.6.17' ''' if '#' in ver: ver, _ = ver.split('#', 1) ver = ver.strip() return ver.strip('\'').st...
[ "def", "_parse_ver", "(", "ver", ")", ":", "if", "'#'", "in", "ver", ":", "ver", ",", "_", "=", "ver", ".", "split", "(", "'#'", ",", "1", ")", "ver", "=", "ver", ".", "strip", "(", ")", "return", "ver", ".", "strip", "(", "'\\''", ")", ".", ...
>>> _parse_ver("'3.4' # pyzmq 17.1.0 stopped building wheels for python3.4") '3.4' >>> _parse_ver('"3.4"') '3.4' >>> _parse_ver('"2.6.17"') '2.6.17'
[ ">>>", "_parse_ver", "(", "3", ".", "4", "#", "pyzmq", "17", ".", "1", ".", "0", "stopped", "building", "wheels", "for", "python3", ".", "4", ")", "3", ".", "4", ">>>", "_parse_ver", "(", "3", ".", "4", ")", "3", ".", "4", ">>>", "_parse_ver", ...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/setup.py#L178-L190
train
saltstack/salt
setup.py
_check_ver
def _check_ver(pyver, op, wanted): ''' >>> _check_ver('2.7.15', 'gt', '2.7') True >>> _check_ver('2.7.15', 'gt', '2.7.15') False >>> _check_ver('2.7.15', 'ge', '2.7.15') True >>> _check_ver('2.7.15', 'eq', '2.7.15') True ''' pyver = distutils.version.LooseVersion(pyver) w...
python
def _check_ver(pyver, op, wanted): ''' >>> _check_ver('2.7.15', 'gt', '2.7') True >>> _check_ver('2.7.15', 'gt', '2.7.15') False >>> _check_ver('2.7.15', 'ge', '2.7.15') True >>> _check_ver('2.7.15', 'eq', '2.7.15') True ''' pyver = distutils.version.LooseVersion(pyver) w...
[ "def", "_check_ver", "(", "pyver", ",", "op", ",", "wanted", ")", ":", "pyver", "=", "distutils", ".", "version", ".", "LooseVersion", "(", "pyver", ")", "wanted", "=", "distutils", ".", "version", ".", "LooseVersion", "(", "wanted", ")", "return", "geta...
>>> _check_ver('2.7.15', 'gt', '2.7') True >>> _check_ver('2.7.15', 'gt', '2.7.15') False >>> _check_ver('2.7.15', 'ge', '2.7.15') True >>> _check_ver('2.7.15', 'eq', '2.7.15') True
[ ">>>", "_check_ver", "(", "2", ".", "7", ".", "15", "gt", "2", ".", "7", ")", "True", ">>>", "_check_ver", "(", "2", ".", "7", ".", "15", "gt", "2", ".", "7", ".", "15", ")", "False", ">>>", "_check_ver", "(", "2", ".", "7", ".", "15", "ge"...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/setup.py#L193-L206
train
saltstack/salt
salt/modules/mac_portspkg.py
list_pkgs
def list_pkgs(versions_as_list=False, **kwargs): ''' List the packages currently installed in a dict:: {'<package_name>': '<version>'} CLI Example: .. code-block:: bash salt '*' pkg.list_pkgs ''' versions_as_list = salt.utils.data.is_true(versions_as_list) # 'removed', 'p...
python
def list_pkgs(versions_as_list=False, **kwargs): ''' List the packages currently installed in a dict:: {'<package_name>': '<version>'} CLI Example: .. code-block:: bash salt '*' pkg.list_pkgs ''' versions_as_list = salt.utils.data.is_true(versions_as_list) # 'removed', 'p...
[ "def", "list_pkgs", "(", "versions_as_list", "=", "False", ",", "*", "*", "kwargs", ")", ":", "versions_as_list", "=", "salt", ".", "utils", ".", "data", ".", "is_true", "(", "versions_as_list", ")", "# 'removed', 'purge_desired' not yet implemented or not applicable"...
List the packages currently installed in a dict:: {'<package_name>': '<version>'} CLI Example: .. code-block:: bash salt '*' pkg.list_pkgs
[ "List", "the", "packages", "currently", "installed", "in", "a", "dict", "::" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_portspkg.py#L87-L129
train
saltstack/salt
salt/modules/mac_portspkg.py
remove
def remove(name=None, pkgs=None, **kwargs): ''' Removes packages with ``port uninstall``. name The name of the package to be deleted. Multiple Package Options: pkgs A list of packages to delete. Must be passed as a python list. The ``name`` parameter will be ignored if th...
python
def remove(name=None, pkgs=None, **kwargs): ''' Removes packages with ``port uninstall``. name The name of the package to be deleted. Multiple Package Options: pkgs A list of packages to delete. Must be passed as a python list. The ``name`` parameter will be ignored if th...
[ "def", "remove", "(", "name", "=", "None", ",", "pkgs", "=", "None", ",", "*", "*", "kwargs", ")", ":", "pkg_params", "=", "__salt__", "[", "'pkg_resource.parse_targets'", "]", "(", "name", ",", "pkgs", ",", "*", "*", "kwargs", ")", "[", "0", "]", ...
Removes packages with ``port uninstall``. name The name of the package to be deleted. Multiple Package Options: pkgs A list of packages to delete. Must be passed as a python list. The ``name`` parameter will be ignored if this option is passed. .. versionadded:: 0.16.0 ...
[ "Removes", "packages", "with", "port", "uninstall", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_portspkg.py#L187-L240
train
saltstack/salt
salt/modules/mac_portspkg.py
install
def install(name=None, refresh=False, pkgs=None, **kwargs): ''' Install the passed package(s) with ``port install`` name The name of the formula to be installed. Note that this parameter is ignored if "pkgs" is passed. CLI Example: .. code-block:: bash salt '*...
python
def install(name=None, refresh=False, pkgs=None, **kwargs): ''' Install the passed package(s) with ``port install`` name The name of the formula to be installed. Note that this parameter is ignored if "pkgs" is passed. CLI Example: .. code-block:: bash salt '*...
[ "def", "install", "(", "name", "=", "None", ",", "refresh", "=", "False", ",", "pkgs", "=", "None", ",", "*", "*", "kwargs", ")", ":", "pkg_params", ",", "pkg_type", "=", "__salt__", "[", "'pkg_resource.parse_targets'", "]", "(", "name", ",", "pkgs", "...
Install the passed package(s) with ``port install`` name The name of the formula to be installed. Note that this parameter is ignored if "pkgs" is passed. CLI Example: .. code-block:: bash salt '*' pkg.install <package name> version Specify a version to p...
[ "Install", "the", "passed", "package", "(", "s", ")", "with", "port", "install" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_portspkg.py#L243-L355
train
saltstack/salt
salt/modules/mac_portspkg.py
refresh_db
def refresh_db(**kwargs): ''' Update ports with ``port selfupdate`` CLI Example: .. code-block:: bash salt mac pkg.refresh_db ''' # Remove rtag file to keep multiple refreshes from happening in pkg states salt.utils.pkg.clear_rtag(__opts__) cmd = ['port', 'selfupdate'] ret...
python
def refresh_db(**kwargs): ''' Update ports with ``port selfupdate`` CLI Example: .. code-block:: bash salt mac pkg.refresh_db ''' # Remove rtag file to keep multiple refreshes from happening in pkg states salt.utils.pkg.clear_rtag(__opts__) cmd = ['port', 'selfupdate'] ret...
[ "def", "refresh_db", "(", "*", "*", "kwargs", ")", ":", "# Remove rtag file to keep multiple refreshes from happening in pkg states", "salt", ".", "utils", ".", "pkg", ".", "clear_rtag", "(", "__opts__", ")", "cmd", "=", "[", "'port'", ",", "'selfupdate'", "]", "r...
Update ports with ``port selfupdate`` CLI Example: .. code-block:: bash salt mac pkg.refresh_db
[ "Update", "ports", "with", "port", "selfupdate" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_portspkg.py#L392-L405
train
saltstack/salt
salt/modules/sdb.py
set_
def set_(uri, value): ''' Set a value in a db, using a uri in the form of ``sdb://<profile>/<key>``. If the uri provided does not start with ``sdb://`` or the value is not successfully set, return ``False``. CLI Example: .. code-block:: bash salt '*' sdb.set sdb://mymemcached/foo bar ...
python
def set_(uri, value): ''' Set a value in a db, using a uri in the form of ``sdb://<profile>/<key>``. If the uri provided does not start with ``sdb://`` or the value is not successfully set, return ``False``. CLI Example: .. code-block:: bash salt '*' sdb.set sdb://mymemcached/foo bar ...
[ "def", "set_", "(", "uri", ",", "value", ")", ":", "return", "salt", ".", "utils", ".", "sdb", ".", "sdb_set", "(", "uri", ",", "value", ",", "__opts__", ",", "__utils__", ")" ]
Set a value in a db, using a uri in the form of ``sdb://<profile>/<key>``. If the uri provided does not start with ``sdb://`` or the value is not successfully set, return ``False``. CLI Example: .. code-block:: bash salt '*' sdb.set sdb://mymemcached/foo bar
[ "Set", "a", "value", "in", "a", "db", "using", "a", "uri", "in", "the", "form", "of", "sdb", ":", "//", "<profile", ">", "/", "<key", ">", ".", "If", "the", "uri", "provided", "does", "not", "start", "with", "sdb", ":", "//", "or", "the", "value"...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/sdb.py#L31-L43
train
saltstack/salt
salt/modules/sdb.py
get_or_set_hash
def get_or_set_hash(uri, length=8, chars='abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)'): ''' Perform a one-time generation of a hash and write it to sdb. If that value has already been set return the value instead. This is useful for generating passwords or keys that are specific...
python
def get_or_set_hash(uri, length=8, chars='abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)'): ''' Perform a one-time generation of a hash and write it to sdb. If that value has already been set return the value instead. This is useful for generating passwords or keys that are specific...
[ "def", "get_or_set_hash", "(", "uri", ",", "length", "=", "8", ",", "chars", "=", "'abcdefghijklmnopqrstuvwxyz0123456789!@#$%^&*(-_=+)'", ")", ":", "return", "salt", ".", "utils", ".", "sdb", ".", "sdb_get_or_set_hash", "(", "uri", ",", "__opts__", ",", "length"...
Perform a one-time generation of a hash and write it to sdb. If that value has already been set return the value instead. This is useful for generating passwords or keys that are specific to multiple minions that need to be stored somewhere centrally. State Example: .. code-block:: yaml ...
[ "Perform", "a", "one", "-", "time", "generation", "of", "a", "hash", "and", "write", "it", "to", "sdb", ".", "If", "that", "value", "has", "already", "been", "set", "return", "the", "value", "instead", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/sdb.py#L61-L94
train
saltstack/salt
salt/modules/csf.py
_temp_exists
def _temp_exists(method, ip): ''' Checks if the ip exists as a temporary rule based on the method supplied, (tempallow, tempdeny). ''' _type = method.replace('temp', '').upper() cmd = "csf -t | awk -v code=1 -v type=_type -v ip=ip '$1==type && $2==ip {{code=0}} END {{exit code}}'".format(_type=_...
python
def _temp_exists(method, ip): ''' Checks if the ip exists as a temporary rule based on the method supplied, (tempallow, tempdeny). ''' _type = method.replace('temp', '').upper() cmd = "csf -t | awk -v code=1 -v type=_type -v ip=ip '$1==type && $2==ip {{code=0}} END {{exit code}}'".format(_type=_...
[ "def", "_temp_exists", "(", "method", ",", "ip", ")", ":", "_type", "=", "method", ".", "replace", "(", "'temp'", ",", "''", ")", ".", "upper", "(", ")", "cmd", "=", "\"csf -t | awk -v code=1 -v type=_type -v ip=ip '$1==type && $2==ip {{code=0}} END {{exit code}}'\"",...
Checks if the ip exists as a temporary rule based on the method supplied, (tempallow, tempdeny).
[ "Checks", "if", "the", "ip", "exists", "as", "a", "temporary", "rule", "based", "on", "the", "method", "supplied", "(", "tempallow", "tempdeny", ")", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/csf.py#L31-L39
train
saltstack/salt
salt/modules/csf.py
exists
def exists(method, ip, port=None, proto='tcp', direction='in', port_origin='d', ip_origin='d', ttl=None, comment=''): ''' Returns true a rule for the ip already exists based on the method supplied. Returns false ...
python
def exists(method, ip, port=None, proto='tcp', direction='in', port_origin='d', ip_origin='d', ttl=None, comment=''): ''' Returns true a rule for the ip already exists based on the method supplied. Returns false ...
[ "def", "exists", "(", "method", ",", "ip", ",", "port", "=", "None", ",", "proto", "=", "'tcp'", ",", "direction", "=", "'in'", ",", "port_origin", "=", "'d'", ",", "ip_origin", "=", "'d'", ",", "ttl", "=", "None", ",", "comment", "=", "''", ")", ...
Returns true a rule for the ip already exists based on the method supplied. Returns false if not found. CLI Example: .. code-block:: bash salt '*' csf.exists allow 1.2.3.4 salt '*' csf.exists tempdeny 1.2.3.4
[ "Returns", "true", "a", "rule", "for", "the", "ip", "already", "exists", "based", "on", "the", "method", "supplied", ".", "Returns", "false", "if", "not", "found", ".", "CLI", "Example", ":" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/csf.py#L47-L73
train
saltstack/salt
salt/modules/csf.py
__csf_cmd
def __csf_cmd(cmd): ''' Execute csf command ''' csf_cmd = '{0} {1}'.format(salt.utils.path.which('csf'), cmd) out = __salt__['cmd.run_all'](csf_cmd) if out['retcode'] != 0: if not out['stderr']: ret = out['stdout'] else: ret = out['stderr'] raise ...
python
def __csf_cmd(cmd): ''' Execute csf command ''' csf_cmd = '{0} {1}'.format(salt.utils.path.which('csf'), cmd) out = __salt__['cmd.run_all'](csf_cmd) if out['retcode'] != 0: if not out['stderr']: ret = out['stdout'] else: ret = out['stderr'] raise ...
[ "def", "__csf_cmd", "(", "cmd", ")", ":", "csf_cmd", "=", "'{0} {1}'", ".", "format", "(", "salt", ".", "utils", ".", "path", ".", "which", "(", "'csf'", ")", ",", "cmd", ")", "out", "=", "__salt__", "[", "'cmd.run_all'", "]", "(", "csf_cmd", ")", ...
Execute csf command
[ "Execute", "csf", "command" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/csf.py#L76-L93
train
saltstack/salt
salt/modules/csf.py
_build_args
def _build_args(method, ip, comment): ''' Returns the cmd args for csf basic allow/deny commands. ''' opt = _get_opt(method) args = '{0} {1}'.format(opt, ip) if comment: args += ' {0}'.format(comment) return args
python
def _build_args(method, ip, comment): ''' Returns the cmd args for csf basic allow/deny commands. ''' opt = _get_opt(method) args = '{0} {1}'.format(opt, ip) if comment: args += ' {0}'.format(comment) return args
[ "def", "_build_args", "(", "method", ",", "ip", ",", "comment", ")", ":", "opt", "=", "_get_opt", "(", "method", ")", "args", "=", "'{0} {1}'", ".", "format", "(", "opt", ",", "ip", ")", "if", "comment", ":", "args", "+=", "' {0}'", ".", "format", ...
Returns the cmd args for csf basic allow/deny commands.
[ "Returns", "the", "cmd", "args", "for", "csf", "basic", "allow", "/", "deny", "commands", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/csf.py#L121-L129
train
saltstack/salt
salt/modules/csf.py
_access_rule
def _access_rule(method, ip=None, port=None, proto='tcp', direction='in', port_origin='d', ip_origin='d', comment=''): ''' Handles the cmd execution for allow and deny commands. ''' if _status...
python
def _access_rule(method, ip=None, port=None, proto='tcp', direction='in', port_origin='d', ip_origin='d', comment=''): ''' Handles the cmd execution for allow and deny commands. ''' if _status...
[ "def", "_access_rule", "(", "method", ",", "ip", "=", "None", ",", "port", "=", "None", ",", "proto", "=", "'tcp'", ",", "direction", "=", "'in'", ",", "port_origin", "=", "'d'", ",", "ip_origin", "=", "'d'", ",", "comment", "=", "''", ")", ":", "i...
Handles the cmd execution for allow and deny commands.
[ "Handles", "the", "cmd", "execution", "for", "allow", "and", "deny", "commands", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/csf.py#L132-L159
train
saltstack/salt
salt/modules/csf.py
_csf_to_list
def _csf_to_list(option): ''' Extract comma-separated values from a csf.conf option and return a list. ''' result = [] line = get_option(option) if line: csv = line.split('=')[1].replace(' ', '').replace('"', '') result = csv.split(',') return result
python
def _csf_to_list(option): ''' Extract comma-separated values from a csf.conf option and return a list. ''' result = [] line = get_option(option) if line: csv = line.split('=')[1].replace(' ', '').replace('"', '') result = csv.split(',') return result
[ "def", "_csf_to_list", "(", "option", ")", ":", "result", "=", "[", "]", "line", "=", "get_option", "(", "option", ")", "if", "line", ":", "csv", "=", "line", ".", "split", "(", "'='", ")", "[", "1", "]", ".", "replace", "(", "' '", ",", "''", ...
Extract comma-separated values from a csf.conf option and return a list.
[ "Extract", "comma", "-", "separated", "values", "from", "a", "csf", ".", "conf", "option", "and", "return", "a", "list", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/csf.py#L204-L214
train
saltstack/salt
salt/modules/csf.py
_tmp_access_rule
def _tmp_access_rule(method, ip=None, ttl=None, port=None, direction='in', port_origin='d', ip_origin='d', comment=''): ''' Handles the cmd execution for tempdeny and tempa...
python
def _tmp_access_rule(method, ip=None, ttl=None, port=None, direction='in', port_origin='d', ip_origin='d', comment=''): ''' Handles the cmd execution for tempdeny and tempa...
[ "def", "_tmp_access_rule", "(", "method", ",", "ip", "=", "None", ",", "ttl", "=", "None", ",", "port", "=", "None", ",", "direction", "=", "'in'", ",", "port_origin", "=", "'d'", ",", "ip_origin", "=", "'d'", ",", "comment", "=", "''", ")", ":", "...
Handles the cmd execution for tempdeny and tempallow commands.
[ "Handles", "the", "cmd", "execution", "for", "tempdeny", "and", "tempallow", "commands", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/csf.py#L308-L325
train
saltstack/salt
salt/modules/csf.py
_build_tmp_access_args
def _build_tmp_access_args(method, ip, ttl, port, direction, comment): ''' Builds the cmd args for temporary access/deny opts. ''' opt = _get_opt(method) args = '{0} {1} {2}'.format(opt, ip, ttl) if port: args += ' -p {0}'.format(port) if direction: args += ' -d {0}'.format(d...
python
def _build_tmp_access_args(method, ip, ttl, port, direction, comment): ''' Builds the cmd args for temporary access/deny opts. ''' opt = _get_opt(method) args = '{0} {1} {2}'.format(opt, ip, ttl) if port: args += ' -p {0}'.format(port) if direction: args += ' -d {0}'.format(d...
[ "def", "_build_tmp_access_args", "(", "method", ",", "ip", ",", "ttl", ",", "port", ",", "direction", ",", "comment", ")", ":", "opt", "=", "_get_opt", "(", "method", ")", "args", "=", "'{0} {1} {2}'", ".", "format", "(", "opt", ",", "ip", ",", "ttl", ...
Builds the cmd args for temporary access/deny opts.
[ "Builds", "the", "cmd", "args", "for", "temporary", "access", "/", "deny", "opts", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/csf.py#L328-L340
train
saltstack/salt
salt/modules/csf.py
tempallow
def tempallow(ip=None, ttl=None, port=None, direction=None, comment=''): ''' Add an rule to the temporary ip allow list. See :func:`_access_rule`. 1- Add an IP: CLI Example: .. code-block:: bash salt '*' csf.tempallow 127.0.0.1 3600 port=22 direction='in' comment='# Temp dev ssh access...
python
def tempallow(ip=None, ttl=None, port=None, direction=None, comment=''): ''' Add an rule to the temporary ip allow list. See :func:`_access_rule`. 1- Add an IP: CLI Example: .. code-block:: bash salt '*' csf.tempallow 127.0.0.1 3600 port=22 direction='in' comment='# Temp dev ssh access...
[ "def", "tempallow", "(", "ip", "=", "None", ",", "ttl", "=", "None", ",", "port", "=", "None", ",", "direction", "=", "None", ",", "comment", "=", "''", ")", ":", "return", "_tmp_access_rule", "(", "'tempallow'", ",", "ip", ",", "ttl", ",", "port", ...
Add an rule to the temporary ip allow list. See :func:`_access_rule`. 1- Add an IP: CLI Example: .. code-block:: bash salt '*' csf.tempallow 127.0.0.1 3600 port=22 direction='in' comment='# Temp dev ssh access'
[ "Add", "an", "rule", "to", "the", "temporary", "ip", "allow", "list", ".", "See", ":", "func", ":", "_access_rule", ".", "1", "-", "Add", "an", "IP", ":", "CLI", "Example", ":" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/csf.py#L393-L404
train
saltstack/salt
salt/modules/csf.py
tempdeny
def tempdeny(ip=None, ttl=None, port=None, direction=None, comment=''): ''' Add a rule to the temporary ip deny list. See :func:`_access_rule`. 1- Add an IP: CLI Example: .. code-block:: bash salt '*' csf.tempdeny 127.0.0.1 300 port=22 direction='in' comment='# Brute force attempt' ...
python
def tempdeny(ip=None, ttl=None, port=None, direction=None, comment=''): ''' Add a rule to the temporary ip deny list. See :func:`_access_rule`. 1- Add an IP: CLI Example: .. code-block:: bash salt '*' csf.tempdeny 127.0.0.1 300 port=22 direction='in' comment='# Brute force attempt' ...
[ "def", "tempdeny", "(", "ip", "=", "None", ",", "ttl", "=", "None", ",", "port", "=", "None", ",", "direction", "=", "None", ",", "comment", "=", "''", ")", ":", "return", "_tmp_access_rule", "(", "'tempdeny'", ",", "ip", ",", "ttl", ",", "port", "...
Add a rule to the temporary ip deny list. See :func:`_access_rule`. 1- Add an IP: CLI Example: .. code-block:: bash salt '*' csf.tempdeny 127.0.0.1 300 port=22 direction='in' comment='# Brute force attempt'
[ "Add", "a", "rule", "to", "the", "temporary", "ip", "deny", "list", ".", "See", ":", "func", ":", "_access_rule", ".", "1", "-", "Add", "an", "IP", ":", "CLI", "Example", ":" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/csf.py#L407-L418
train
saltstack/salt
salt/modules/csf.py
allow
def allow(ip, port=None, proto='tcp', direction='in', port_origin='d', ip_origin='s', ttl=None, comment=''): ''' Add an rule to csf allowed hosts See :func:`_access_rule`. 1- Add an IP: CLI Example: .. code-block:: bash salt '*' c...
python
def allow(ip, port=None, proto='tcp', direction='in', port_origin='d', ip_origin='s', ttl=None, comment=''): ''' Add an rule to csf allowed hosts See :func:`_access_rule`. 1- Add an IP: CLI Example: .. code-block:: bash salt '*' c...
[ "def", "allow", "(", "ip", ",", "port", "=", "None", ",", "proto", "=", "'tcp'", ",", "direction", "=", "'in'", ",", "port_origin", "=", "'d'", ",", "ip_origin", "=", "'s'", ",", "ttl", "=", "None", ",", "comment", "=", "''", ")", ":", "return", ...
Add an rule to csf allowed hosts See :func:`_access_rule`. 1- Add an IP: CLI Example: .. code-block:: bash salt '*' csf.allow 127.0.0.1 salt '*' csf.allow 127.0.0.1 comment="Allow localhost"
[ "Add", "an", "rule", "to", "csf", "allowed", "hosts", "See", ":", "func", ":", "_access_rule", ".", "1", "-", "Add", "an", "IP", ":", "CLI", "Example", ":" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/csf.py#L421-L447
train
saltstack/salt
salt/modules/csf.py
deny
def deny(ip, port=None, proto='tcp', direction='in', port_origin='d', ip_origin='d', ttl=None, comment=''): ''' Add an rule to csf denied hosts See :func:`_access_rule`. 1- Deny an IP: CLI Example: .. code-block:: bash salt '*' cs...
python
def deny(ip, port=None, proto='tcp', direction='in', port_origin='d', ip_origin='d', ttl=None, comment=''): ''' Add an rule to csf denied hosts See :func:`_access_rule`. 1- Deny an IP: CLI Example: .. code-block:: bash salt '*' cs...
[ "def", "deny", "(", "ip", ",", "port", "=", "None", ",", "proto", "=", "'tcp'", ",", "direction", "=", "'in'", ",", "port_origin", "=", "'d'", ",", "ip_origin", "=", "'d'", ",", "ttl", "=", "None", ",", "comment", "=", "''", ")", ":", "return", "...
Add an rule to csf denied hosts See :func:`_access_rule`. 1- Deny an IP: CLI Example: .. code-block:: bash salt '*' csf.deny 127.0.0.1 salt '*' csf.deny 127.0.0.1 comment="Too localhosty"
[ "Add", "an", "rule", "to", "csf", "denied", "hosts", "See", ":", "func", ":", "_access_rule", ".", "1", "-", "Deny", "an", "IP", ":", "CLI", "Example", ":" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/csf.py#L450-L469
train
saltstack/salt
salt/modules/csf.py
allow_ports
def allow_ports(ports, proto='tcp', direction='in'): ''' Fully replace the incoming or outgoing ports line in the csf.conf file - e.g. TCP_IN, TCP_OUT, UDP_IN, UDP_OUT, etc. CLI Example: .. code-block:: bash salt '*' csf.allow_ports ports="[22,80,443,4505,4506]" proto='tcp' direction=...
python
def allow_ports(ports, proto='tcp', direction='in'): ''' Fully replace the incoming or outgoing ports line in the csf.conf file - e.g. TCP_IN, TCP_OUT, UDP_IN, UDP_OUT, etc. CLI Example: .. code-block:: bash salt '*' csf.allow_ports ports="[22,80,443,4505,4506]" proto='tcp' direction=...
[ "def", "allow_ports", "(", "ports", ",", "proto", "=", "'tcp'", ",", "direction", "=", "'in'", ")", ":", "results", "=", "[", "]", "ports", "=", "set", "(", "ports", ")", "ports", "=", "list", "(", "ports", ")", "proto", "=", "proto", ".", "upper",...
Fully replace the incoming or outgoing ports line in the csf.conf file - e.g. TCP_IN, TCP_OUT, UDP_IN, UDP_OUT, etc. CLI Example: .. code-block:: bash salt '*' csf.allow_ports ports="[22,80,443,4505,4506]" proto='tcp' direction='in'
[ "Fully", "replace", "the", "incoming", "or", "outgoing", "ports", "line", "in", "the", "csf", ".", "conf", "file", "-", "e", ".", "g", ".", "TCP_IN", "TCP_OUT", "UDP_IN", "UDP_OUT", "etc", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/csf.py#L535-L563
train
saltstack/salt
salt/modules/csf.py
get_ports
def get_ports(proto='tcp', direction='in'): ''' Lists ports from csf.conf based on direction and protocol. e.g. - TCP_IN, TCP_OUT, UDP_IN, UDP_OUT, etc.. CLI Example: .. code-block:: bash salt '*' csf.allow_port 22 proto='tcp' direction='in' ''' proto = proto.upper() directio...
python
def get_ports(proto='tcp', direction='in'): ''' Lists ports from csf.conf based on direction and protocol. e.g. - TCP_IN, TCP_OUT, UDP_IN, UDP_OUT, etc.. CLI Example: .. code-block:: bash salt '*' csf.allow_port 22 proto='tcp' direction='in' ''' proto = proto.upper() directio...
[ "def", "get_ports", "(", "proto", "=", "'tcp'", ",", "direction", "=", "'in'", ")", ":", "proto", "=", "proto", ".", "upper", "(", ")", "direction", "=", "direction", ".", "upper", "(", ")", "results", "=", "{", "}", "_validate_direction_and_proto", "(",...
Lists ports from csf.conf based on direction and protocol. e.g. - TCP_IN, TCP_OUT, UDP_IN, UDP_OUT, etc.. CLI Example: .. code-block:: bash salt '*' csf.allow_port 22 proto='tcp' direction='in'
[ "Lists", "ports", "from", "csf", ".", "conf", "based", "on", "direction", "and", "protocol", ".", "e", ".", "g", ".", "-", "TCP_IN", "TCP_OUT", "UDP_IN", "UDP_OUT", "etc", ".." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/csf.py#L566-L587
train
saltstack/salt
salt/modules/csf.py
allow_port
def allow_port(port, proto='tcp', direction='both'): ''' Like allow_ports, but it will append to the existing entry instead of replacing it. Takes a single port instead of a list of ports. CLI Example: .. code-block:: bash salt '*' csf.allow_port 22 proto='tcp' direction='in' ''' ...
python
def allow_port(port, proto='tcp', direction='both'): ''' Like allow_ports, but it will append to the existing entry instead of replacing it. Takes a single port instead of a list of ports. CLI Example: .. code-block:: bash salt '*' csf.allow_port 22 proto='tcp' direction='in' ''' ...
[ "def", "allow_port", "(", "port", ",", "proto", "=", "'tcp'", ",", "direction", "=", "'both'", ")", ":", "ports", "=", "get_ports", "(", "proto", "=", "proto", ",", "direction", "=", "direction", ")", "direction", "=", "direction", ".", "upper", "(", "...
Like allow_ports, but it will append to the existing entry instead of replacing it. Takes a single port instead of a list of ports. CLI Example: .. code-block:: bash salt '*' csf.allow_port 22 proto='tcp' direction='in'
[ "Like", "allow_ports", "but", "it", "will", "append", "to", "the", "existing", "entry", "instead", "of", "replacing", "it", ".", "Takes", "a", "single", "port", "instead", "of", "a", "list", "of", "ports", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/csf.py#L611-L633
train
saltstack/salt
salt/client/ssh/wrapper/state.py
_ssh_state
def _ssh_state(chunks, st_kwargs, kwargs, test=False): ''' Function to run a state with the given chunk via salt-ssh ''' file_refs = salt.client.ssh.state.lowstate_file_refs( chunks, _merge_extra_filerefs( kwargs.get('extra_filerefs', ''), ...
python
def _ssh_state(chunks, st_kwargs, kwargs, test=False): ''' Function to run a state with the given chunk via salt-ssh ''' file_refs = salt.client.ssh.state.lowstate_file_refs( chunks, _merge_extra_filerefs( kwargs.get('extra_filerefs', ''), ...
[ "def", "_ssh_state", "(", "chunks", ",", "st_kwargs", ",", "kwargs", ",", "test", "=", "False", ")", ":", "file_refs", "=", "salt", ".", "client", ".", "ssh", ".", "state", ".", "lowstate_file_refs", "(", "chunks", ",", "_merge_extra_filerefs", "(", "kwarg...
Function to run a state with the given chunk via salt-ssh
[ "Function", "to", "run", "a", "state", "with", "the", "given", "chunk", "via", "salt", "-", "ssh" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L39-L89
train
saltstack/salt
salt/client/ssh/wrapper/state.py
_set_retcode
def _set_retcode(ret, highstate=None): ''' Set the return code based on the data back from the state system ''' # Set default retcode to 0 __context__['retcode'] = 0 if isinstance(ret, list): __context__['retcode'] = 1 return if not salt.utils.state.check_result(ret, highst...
python
def _set_retcode(ret, highstate=None): ''' Set the return code based on the data back from the state system ''' # Set default retcode to 0 __context__['retcode'] = 0 if isinstance(ret, list): __context__['retcode'] = 1 return if not salt.utils.state.check_result(ret, highst...
[ "def", "_set_retcode", "(", "ret", ",", "highstate", "=", "None", ")", ":", "# Set default retcode to 0", "__context__", "[", "'retcode'", "]", "=", "0", "if", "isinstance", "(", "ret", ",", "list", ")", ":", "__context__", "[", "'retcode'", "]", "=", "1",...
Set the return code based on the data back from the state system
[ "Set", "the", "return", "code", "based", "on", "the", "data", "back", "from", "the", "state", "system" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L92-L105
train
saltstack/salt
salt/client/ssh/wrapper/state.py
_check_pillar
def _check_pillar(kwargs, pillar=None): ''' Check the pillar for errors, refuse to run the state if there are errors in the pillar and return the pillar errors ''' if kwargs.get('force'): return True pillar_dict = pillar if pillar is not None else __pillar__ if '_errors' in pillar_di...
python
def _check_pillar(kwargs, pillar=None): ''' Check the pillar for errors, refuse to run the state if there are errors in the pillar and return the pillar errors ''' if kwargs.get('force'): return True pillar_dict = pillar if pillar is not None else __pillar__ if '_errors' in pillar_di...
[ "def", "_check_pillar", "(", "kwargs", ",", "pillar", "=", "None", ")", ":", "if", "kwargs", ".", "get", "(", "'force'", ")", ":", "return", "True", "pillar_dict", "=", "pillar", "if", "pillar", "is", "not", "None", "else", "__pillar__", "if", "'_errors'...
Check the pillar for errors, refuse to run the state if there are errors in the pillar and return the pillar errors
[ "Check", "the", "pillar", "for", "errors", "refuse", "to", "run", "the", "state", "if", "there", "are", "errors", "in", "the", "pillar", "and", "return", "the", "pillar", "errors" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L108-L118
train
saltstack/salt
salt/client/ssh/wrapper/state.py
_wait
def _wait(jid): ''' Wait for all previously started state jobs to finish running ''' if jid is None: jid = salt.utils.jid.gen_jid(__opts__) states = _prior_running_states(jid) while states: time.sleep(1) states = _prior_running_states(jid)
python
def _wait(jid): ''' Wait for all previously started state jobs to finish running ''' if jid is None: jid = salt.utils.jid.gen_jid(__opts__) states = _prior_running_states(jid) while states: time.sleep(1) states = _prior_running_states(jid)
[ "def", "_wait", "(", "jid", ")", ":", "if", "jid", "is", "None", ":", "jid", "=", "salt", ".", "utils", ".", "jid", ".", "gen_jid", "(", "__opts__", ")", "states", "=", "_prior_running_states", "(", "jid", ")", "while", "states", ":", "time", ".", ...
Wait for all previously started state jobs to finish running
[ "Wait", "for", "all", "previously", "started", "state", "jobs", "to", "finish", "running" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L121-L130
train
saltstack/salt
salt/client/ssh/wrapper/state.py
_merge_extra_filerefs
def _merge_extra_filerefs(*args): ''' Takes a list of filerefs and returns a merged list ''' ret = [] for arg in args: if isinstance(arg, six.string_types): if arg: ret.extend(arg.split(',')) elif isinstance(arg, list): if arg: ...
python
def _merge_extra_filerefs(*args): ''' Takes a list of filerefs and returns a merged list ''' ret = [] for arg in args: if isinstance(arg, six.string_types): if arg: ret.extend(arg.split(',')) elif isinstance(arg, list): if arg: ...
[ "def", "_merge_extra_filerefs", "(", "*", "args", ")", ":", "ret", "=", "[", "]", "for", "arg", "in", "args", ":", "if", "isinstance", "(", "arg", ",", "six", ".", "string_types", ")", ":", "if", "arg", ":", "ret", ".", "extend", "(", "arg", ".", ...
Takes a list of filerefs and returns a merged list
[ "Takes", "a", "list", "of", "filerefs", "and", "returns", "a", "merged", "list" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L133-L145
train
saltstack/salt
salt/client/ssh/wrapper/state.py
_cleanup_slsmod_high_data
def _cleanup_slsmod_high_data(high_data): ''' Set "slsmod" keys to None to make high_data JSON serializable ''' for i in six.itervalues(high_data): if 'stateconf' in i: stateconf_data = i['stateconf'][1] if 'slsmod' in stateconf_data: stateconf_data['s...
python
def _cleanup_slsmod_high_data(high_data): ''' Set "slsmod" keys to None to make high_data JSON serializable ''' for i in six.itervalues(high_data): if 'stateconf' in i: stateconf_data = i['stateconf'][1] if 'slsmod' in stateconf_data: stateconf_data['s...
[ "def", "_cleanup_slsmod_high_data", "(", "high_data", ")", ":", "for", "i", "in", "six", ".", "itervalues", "(", "high_data", ")", ":", "if", "'stateconf'", "in", "i", ":", "stateconf_data", "=", "i", "[", "'stateconf'", "]", "[", "1", "]", "if", "'slsmo...
Set "slsmod" keys to None to make high_data JSON serializable
[ "Set", "slsmod", "keys", "to", "None", "to", "make", "high_data", "JSON", "serializable" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L158-L167
train
saltstack/salt
salt/client/ssh/wrapper/state.py
_parse_mods
def _parse_mods(mods): ''' Parse modules. ''' if isinstance(mods, six.string_types): mods = [item.strip() for item in mods.split(',') if item.strip()] return mods
python
def _parse_mods(mods): ''' Parse modules. ''' if isinstance(mods, six.string_types): mods = [item.strip() for item in mods.split(',') if item.strip()] return mods
[ "def", "_parse_mods", "(", "mods", ")", ":", "if", "isinstance", "(", "mods", ",", "six", ".", "string_types", ")", ":", "mods", "=", "[", "item", ".", "strip", "(", ")", "for", "item", "in", "mods", ".", "split", "(", "','", ")", "if", "item", "...
Parse modules.
[ "Parse", "modules", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L170-L177
train
saltstack/salt
salt/client/ssh/wrapper/state.py
sls
def sls(mods, saltenv='base', test=None, exclude=None, **kwargs): ''' Create the seed file for a state.sls run ''' st_kwargs = __salt__.kwargs __opts__['grains'] = __grains__ __pillar__.update(kwargs.get('pillar', {})) opts = salt.utils.state.get_sls_opts(__opts__, **kwargs) st_ = salt.c...
python
def sls(mods, saltenv='base', test=None, exclude=None, **kwargs): ''' Create the seed file for a state.sls run ''' st_kwargs = __salt__.kwargs __opts__['grains'] = __grains__ __pillar__.update(kwargs.get('pillar', {})) opts = salt.utils.state.get_sls_opts(__opts__, **kwargs) st_ = salt.c...
[ "def", "sls", "(", "mods", ",", "saltenv", "=", "'base'", ",", "test", "=", "None", ",", "exclude", "=", "None", ",", "*", "*", "kwargs", ")", ":", "st_kwargs", "=", "__salt__", ".", "kwargs", "__opts__", "[", "'grains'", "]", "=", "__grains__", "__p...
Create the seed file for a state.sls run
[ "Create", "the", "seed", "file", "for", "a", "state", ".", "sls", "run" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L180-L267
train
saltstack/salt
salt/client/ssh/wrapper/state.py
running
def running(concurrent=False): ''' Return a list of strings that contain state return data if a state function is already running. This function is used to prevent multiple state calls from being run at the same time. CLI Example: .. code-block:: bash salt '*' state.running ''' ...
python
def running(concurrent=False): ''' Return a list of strings that contain state return data if a state function is already running. This function is used to prevent multiple state calls from being run at the same time. CLI Example: .. code-block:: bash salt '*' state.running ''' ...
[ "def", "running", "(", "concurrent", "=", "False", ")", ":", "ret", "=", "[", "]", "if", "concurrent", ":", "return", "ret", "active", "=", "__salt__", "[", "'saltutil.is_running'", "]", "(", "'state.*'", ")", "for", "data", "in", "active", ":", "err", ...
Return a list of strings that contain state return data if a state function is already running. This function is used to prevent multiple state calls from being run at the same time. CLI Example: .. code-block:: bash salt '*' state.running
[ "Return", "a", "list", "of", "strings", "that", "contain", "state", "return", "data", "if", "a", "state", "function", "is", "already", "running", ".", "This", "function", "is", "used", "to", "prevent", "multiple", "state", "calls", "from", "being", "run", ...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L270-L297
train
saltstack/salt
salt/client/ssh/wrapper/state.py
_prior_running_states
def _prior_running_states(jid): ''' Return a list of dicts of prior calls to state functions. This function is used to queue state calls so only one is run at a time. ''' ret = [] active = __salt__['saltutil.is_running']('state.*') for data in active: try: data_jid = in...
python
def _prior_running_states(jid): ''' Return a list of dicts of prior calls to state functions. This function is used to queue state calls so only one is run at a time. ''' ret = [] active = __salt__['saltutil.is_running']('state.*') for data in active: try: data_jid = in...
[ "def", "_prior_running_states", "(", "jid", ")", ":", "ret", "=", "[", "]", "active", "=", "__salt__", "[", "'saltutil.is_running'", "]", "(", "'state.*'", ")", "for", "data", "in", "active", ":", "try", ":", "data_jid", "=", "int", "(", "data", "[", "...
Return a list of dicts of prior calls to state functions. This function is used to queue state calls so only one is run at a time.
[ "Return", "a", "list", "of", "dicts", "of", "prior", "calls", "to", "state", "functions", ".", "This", "function", "is", "used", "to", "queue", "state", "calls", "so", "only", "one", "is", "run", "at", "a", "time", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L300-L315
train
saltstack/salt
salt/client/ssh/wrapper/state.py
_check_queue
def _check_queue(queue, kwargs): ''' Utility function to queue the state run if requested and to check for conflicts in currently running states ''' if queue: _wait(kwargs.get('__pub_jid')) else: conflict = running(concurrent=kwargs.get('concurrent', False)) if conflict: ...
python
def _check_queue(queue, kwargs): ''' Utility function to queue the state run if requested and to check for conflicts in currently running states ''' if queue: _wait(kwargs.get('__pub_jid')) else: conflict = running(concurrent=kwargs.get('concurrent', False)) if conflict: ...
[ "def", "_check_queue", "(", "queue", ",", "kwargs", ")", ":", "if", "queue", ":", "_wait", "(", "kwargs", ".", "get", "(", "'__pub_jid'", ")", ")", "else", ":", "conflict", "=", "running", "(", "concurrent", "=", "kwargs", ".", "get", "(", "'concurrent...
Utility function to queue the state run if requested and to check for conflicts in currently running states
[ "Utility", "function", "to", "queue", "the", "state", "run", "if", "requested", "and", "to", "check", "for", "conflicts", "in", "currently", "running", "states" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L318-L329
train
saltstack/salt
salt/client/ssh/wrapper/state.py
low
def low(data, **kwargs): ''' Execute a single low data call This function is mostly intended for testing the state system CLI Example: .. code-block:: bash salt '*' state.low '{"state": "pkg", "fun": "installed", "name": "vi"}' ''' st_kwargs = __salt__.kwargs __opts__['grains'...
python
def low(data, **kwargs): ''' Execute a single low data call This function is mostly intended for testing the state system CLI Example: .. code-block:: bash salt '*' state.low '{"state": "pkg", "fun": "installed", "name": "vi"}' ''' st_kwargs = __salt__.kwargs __opts__['grains'...
[ "def", "low", "(", "data", ",", "*", "*", "kwargs", ")", ":", "st_kwargs", "=", "__salt__", ".", "kwargs", "__opts__", "[", "'grains'", "]", "=", "__grains__", "chunks", "=", "[", "data", "]", "st_", "=", "salt", ".", "client", ".", "ssh", ".", "st...
Execute a single low data call This function is mostly intended for testing the state system CLI Example: .. code-block:: bash salt '*' state.low '{"state": "pkg", "fun": "installed", "name": "vi"}'
[ "Execute", "a", "single", "low", "data", "call", "This", "function", "is", "mostly", "intended", "for", "testing", "the", "state", "system" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L338-L410
train
saltstack/salt
salt/client/ssh/wrapper/state.py
request
def request(mods=None, **kwargs): ''' .. versionadded:: 2017.7.3 Request that the local admin execute a state run via `salt-call state.run_request` All arguments match state.apply CLI Example: .. code-block:: bash salt '*' state.request salt '*' state.request ...
python
def request(mods=None, **kwargs): ''' .. versionadded:: 2017.7.3 Request that the local admin execute a state run via `salt-call state.run_request` All arguments match state.apply CLI Example: .. code-block:: bash salt '*' state.request salt '*' state.request ...
[ "def", "request", "(", "mods", "=", "None", ",", "*", "*", "kwargs", ")", ":", "kwargs", "[", "'test'", "]", "=", "True", "ret", "=", "apply_", "(", "mods", ",", "*", "*", "kwargs", ")", "notify_path", "=", "os", ".", "path", ".", "join", "(", ...
.. versionadded:: 2017.7.3 Request that the local admin execute a state run via `salt-call state.run_request` All arguments match state.apply CLI Example: .. code-block:: bash salt '*' state.request salt '*' state.request test salt '*' state.request test,pkgs
[ "..", "versionadded", "::", "2017", ".", "7", ".", "3" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L525-L565
train
saltstack/salt
salt/client/ssh/wrapper/state.py
clear_request
def clear_request(name=None): ''' .. versionadded:: 2017.7.3 Clear out the state execution request without executing it CLI Example: .. code-block:: bash salt '*' state.clear_request ''' notify_path = os.path.join(__opts__['cachedir'], 'req_state.p') serial = salt.payload.Ser...
python
def clear_request(name=None): ''' .. versionadded:: 2017.7.3 Clear out the state execution request without executing it CLI Example: .. code-block:: bash salt '*' state.clear_request ''' notify_path = os.path.join(__opts__['cachedir'], 'req_state.p') serial = salt.payload.Ser...
[ "def", "clear_request", "(", "name", "=", "None", ")", ":", "notify_path", "=", "os", ".", "path", ".", "join", "(", "__opts__", "[", "'cachedir'", "]", ",", "'req_state.p'", ")", "serial", "=", "salt", ".", "payload", ".", "Serial", "(", "__opts__", "...
.. versionadded:: 2017.7.3 Clear out the state execution request without executing it CLI Example: .. code-block:: bash salt '*' state.clear_request
[ "..", "versionadded", "::", "2017", ".", "7", ".", "3" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L593-L632
train
saltstack/salt
salt/client/ssh/wrapper/state.py
run_request
def run_request(name='default', **kwargs): ''' .. versionadded:: 2017.7.3 Execute the pending state request CLI Example: .. code-block:: bash salt '*' state.run_request ''' req = check_request() if name not in req: return {} n_req = req[name] if 'mods' not in ...
python
def run_request(name='default', **kwargs): ''' .. versionadded:: 2017.7.3 Execute the pending state request CLI Example: .. code-block:: bash salt '*' state.run_request ''' req = check_request() if name not in req: return {} n_req = req[name] if 'mods' not in ...
[ "def", "run_request", "(", "name", "=", "'default'", ",", "*", "*", "kwargs", ")", ":", "req", "=", "check_request", "(", ")", "if", "name", "not", "in", "req", ":", "return", "{", "}", "n_req", "=", "req", "[", "name", "]", "if", "'mods'", "not", ...
.. versionadded:: 2017.7.3 Execute the pending state request CLI Example: .. code-block:: bash salt '*' state.run_request
[ "..", "versionadded", "::", "2017", ".", "7", ".", "3" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L635-L663
train
saltstack/salt
salt/client/ssh/wrapper/state.py
show_highstate
def show_highstate(**kwargs): ''' Retrieve the highstate data from the salt master and display it CLI Example: .. code-block:: bash salt '*' state.show_highstate ''' __opts__['grains'] = __grains__ opts = salt.utils.state.get_sls_opts(__opts__, **kwargs) st_ = salt.client.ssh....
python
def show_highstate(**kwargs): ''' Retrieve the highstate data from the salt master and display it CLI Example: .. code-block:: bash salt '*' state.show_highstate ''' __opts__['grains'] = __grains__ opts = salt.utils.state.get_sls_opts(__opts__, **kwargs) st_ = salt.client.ssh....
[ "def", "show_highstate", "(", "*", "*", "kwargs", ")", ":", "__opts__", "[", "'grains'", "]", "=", "__grains__", "opts", "=", "salt", ".", "utils", ".", "state", ".", "get_sls_opts", "(", "__opts__", ",", "*", "*", "kwargs", ")", "st_", "=", "salt", ...
Retrieve the highstate data from the salt master and display it CLI Example: .. code-block:: bash salt '*' state.show_highstate
[ "Retrieve", "the", "highstate", "data", "from", "the", "salt", "master", "and", "display", "it" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L831-L851
train
saltstack/salt
salt/client/ssh/wrapper/state.py
show_lowstate
def show_lowstate(**kwargs): ''' List out the low data that will be applied to this minion CLI Example: .. code-block:: bash salt '*' state.show_lowstate ''' __opts__['grains'] = __grains__ opts = salt.utils.state.get_sls_opts(__opts__, **kwargs) st_ = salt.client.ssh.state.SS...
python
def show_lowstate(**kwargs): ''' List out the low data that will be applied to this minion CLI Example: .. code-block:: bash salt '*' state.show_lowstate ''' __opts__['grains'] = __grains__ opts = salt.utils.state.get_sls_opts(__opts__, **kwargs) st_ = salt.client.ssh.state.SS...
[ "def", "show_lowstate", "(", "*", "*", "kwargs", ")", ":", "__opts__", "[", "'grains'", "]", "=", "__grains__", "opts", "=", "salt", ".", "utils", ".", "state", ".", "get_sls_opts", "(", "__opts__", ",", "*", "*", "kwargs", ")", "st_", "=", "salt", "...
List out the low data that will be applied to this minion CLI Example: .. code-block:: bash salt '*' state.show_lowstate
[ "List", "out", "the", "low", "data", "that", "will", "be", "applied", "to", "this", "minion" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L854-L874
train
saltstack/salt
salt/client/ssh/wrapper/state.py
sls_id
def sls_id(id_, mods, test=None, queue=False, **kwargs): ''' Call a single ID from the named module(s) and handle all requisites The state ID comes *before* the module ID(s) on the command line. id ID to call mods Comma-delimited list of modules to search for given id and its requ...
python
def sls_id(id_, mods, test=None, queue=False, **kwargs): ''' Call a single ID from the named module(s) and handle all requisites The state ID comes *before* the module ID(s) on the command line. id ID to call mods Comma-delimited list of modules to search for given id and its requ...
[ "def", "sls_id", "(", "id_", ",", "mods", ",", "test", "=", "None", ",", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "st_kwargs", "=", "__salt__", ".", "kwargs", "conflict", "=", "_check_queue", "(", "queue", ",", "kwargs", ")", "if", ...
Call a single ID from the named module(s) and handle all requisites The state ID comes *before* the module ID(s) on the command line. id ID to call mods Comma-delimited list of modules to search for given id and its requisites .. versionadded:: 2017.7.3 saltenv : base Sp...
[ "Call", "a", "single", "ID", "from", "the", "named", "module", "(", "s", ")", "and", "handle", "all", "requisites" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L877-L964
train
saltstack/salt
salt/client/ssh/wrapper/state.py
show_sls
def show_sls(mods, saltenv='base', test=None, **kwargs): ''' Display the state data from a specific sls or list of sls files on the master CLI Example: .. code-block:: bash salt '*' state.show_sls core,edit.vim dev ''' __pillar__.update(kwargs.get('pillar', {})) __opts__['grai...
python
def show_sls(mods, saltenv='base', test=None, **kwargs): ''' Display the state data from a specific sls or list of sls files on the master CLI Example: .. code-block:: bash salt '*' state.show_sls core,edit.vim dev ''' __pillar__.update(kwargs.get('pillar', {})) __opts__['grai...
[ "def", "show_sls", "(", "mods", ",", "saltenv", "=", "'base'", ",", "test", "=", "None", ",", "*", "*", "kwargs", ")", ":", "__pillar__", ".", "update", "(", "kwargs", ".", "get", "(", "'pillar'", ",", "{", "}", ")", ")", "__opts__", "[", "'grains'...
Display the state data from a specific sls or list of sls files on the master CLI Example: .. code-block:: bash salt '*' state.show_sls core,edit.vim dev
[ "Display", "the", "state", "data", "from", "a", "specific", "sls", "or", "list", "of", "sls", "files", "on", "the", "master" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L967-L1005
train
saltstack/salt
salt/client/ssh/wrapper/state.py
show_top
def show_top(**kwargs): ''' Return the top data that the minion will use for a highstate CLI Example: .. code-block:: bash salt '*' state.show_top ''' __opts__['grains'] = __grains__ opts = salt.utils.state.get_sls_opts(__opts__, **kwargs) st_ = salt.client.ssh.state.SSHHighSt...
python
def show_top(**kwargs): ''' Return the top data that the minion will use for a highstate CLI Example: .. code-block:: bash salt '*' state.show_top ''' __opts__['grains'] = __grains__ opts = salt.utils.state.get_sls_opts(__opts__, **kwargs) st_ = salt.client.ssh.state.SSHHighSt...
[ "def", "show_top", "(", "*", "*", "kwargs", ")", ":", "__opts__", "[", "'grains'", "]", "=", "__grains__", "opts", "=", "salt", ".", "utils", ".", "state", ".", "get_sls_opts", "(", "__opts__", ",", "*", "*", "kwargs", ")", "st_", "=", "salt", ".", ...
Return the top data that the minion will use for a highstate CLI Example: .. code-block:: bash salt '*' state.show_top
[ "Return", "the", "top", "data", "that", "the", "minion", "will", "use", "for", "a", "highstate" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L1053-L1076
train
saltstack/salt
salt/client/ssh/wrapper/state.py
single
def single(fun, name, test=None, **kwargs): ''' .. versionadded:: 2015.5.0 Execute a single state function with the named kwargs, returns False if insufficient data is sent to the command By default, the values of the kwargs will be parsed as YAML. So, you can specify lists values, or lists of...
python
def single(fun, name, test=None, **kwargs): ''' .. versionadded:: 2015.5.0 Execute a single state function with the named kwargs, returns False if insufficient data is sent to the command By default, the values of the kwargs will be parsed as YAML. So, you can specify lists values, or lists of...
[ "def", "single", "(", "fun", ",", "name", ",", "test", "=", "None", ",", "*", "*", "kwargs", ")", ":", "st_kwargs", "=", "__salt__", ".", "kwargs", "__opts__", "[", "'grains'", "]", "=", "__grains__", "# state.fun -> [state, fun]", "comps", "=", "fun", "...
.. versionadded:: 2015.5.0 Execute a single state function with the named kwargs, returns False if insufficient data is sent to the command By default, the values of the kwargs will be parsed as YAML. So, you can specify lists values, or lists of single entry key-value maps, as you would in a YAML...
[ "..", "versionadded", "::", "2015", ".", "5", ".", "0" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/client/ssh/wrapper/state.py#L1079-L1198
train
saltstack/salt
salt/modules/datadog_api.py
_initialize_connection
def _initialize_connection(api_key, app_key): ''' Initialize Datadog connection ''' if api_key is None: raise SaltInvocationError('api_key must be specified') if app_key is None: raise SaltInvocationError('app_key must be specified') options = { 'api_key': api_key, ...
python
def _initialize_connection(api_key, app_key): ''' Initialize Datadog connection ''' if api_key is None: raise SaltInvocationError('api_key must be specified') if app_key is None: raise SaltInvocationError('app_key must be specified') options = { 'api_key': api_key, ...
[ "def", "_initialize_connection", "(", "api_key", ",", "app_key", ")", ":", "if", "api_key", "is", "None", ":", "raise", "SaltInvocationError", "(", "'api_key must be specified'", ")", "if", "app_key", "is", "None", ":", "raise", "SaltInvocationError", "(", "'app_k...
Initialize Datadog connection
[ "Initialize", "Datadog", "connection" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/datadog_api.py#L41-L53
train
saltstack/salt
salt/modules/datadog_api.py
schedule_downtime
def schedule_downtime(scope, api_key=None, app_key=None, monitor_id=None, start=None, end=None, message=None, recurrence=None, timezone=None, ...
python
def schedule_downtime(scope, api_key=None, app_key=None, monitor_id=None, start=None, end=None, message=None, recurrence=None, timezone=None, ...
[ "def", "schedule_downtime", "(", "scope", ",", "api_key", "=", "None", ",", "app_key", "=", "None", ",", "monitor_id", "=", "None", ",", "start", "=", "None", ",", "end", "=", "None", ",", "message", "=", "None", ",", "recurrence", "=", "None", ",", ...
Schedule downtime for a scope of monitors. CLI Example: .. code-block:: bash salt-call datadog.schedule_downtime 'host:app2' \\ stop=$(date --date='30 minutes' +%s) \\ app_key='0123456789' \\ ...
[ "Schedule", "downtime", "for", "a", "scope", "of", "monitors", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/datadog_api.py#L56-L120
train
saltstack/salt
salt/modules/datadog_api.py
cancel_downtime
def cancel_downtime(api_key=None, app_key=None, scope=None, id=None): ''' Cancel a downtime by id or by scope. CLI Example: .. code-block:: bash salt-call datadog.cancel_downtime scope='host:app01' \\ ...
python
def cancel_downtime(api_key=None, app_key=None, scope=None, id=None): ''' Cancel a downtime by id or by scope. CLI Example: .. code-block:: bash salt-call datadog.cancel_downtime scope='host:app01' \\ ...
[ "def", "cancel_downtime", "(", "api_key", "=", "None", ",", "app_key", "=", "None", ",", "scope", "=", "None", ",", "id", "=", "None", ")", ":", "if", "api_key", "is", "None", ":", "raise", "SaltInvocationError", "(", "'api_key must be specified'", ")", "i...
Cancel a downtime by id or by scope. CLI Example: .. code-block:: bash salt-call datadog.cancel_downtime scope='host:app01' \\ api_key='0123456789' \\ app_key='9876543210'` Arguments - Either scope or id is requi...
[ "Cancel", "a", "downtime", "by", "id", "or", "by", "scope", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/datadog_api.py#L123-L180
train
saltstack/salt
salt/modules/datadog_api.py
post_event
def post_event(api_key=None, app_key=None, title=None, text=None, date_happened=None, priority=None, host=None, tags=None, alert_type=None, aggregation_key=None, source_t...
python
def post_event(api_key=None, app_key=None, title=None, text=None, date_happened=None, priority=None, host=None, tags=None, alert_type=None, aggregation_key=None, source_t...
[ "def", "post_event", "(", "api_key", "=", "None", ",", "app_key", "=", "None", ",", "title", "=", "None", ",", "text", "=", "None", ",", "date_happened", "=", "None", ",", "priority", "=", "None", ",", "host", "=", "None", ",", "tags", "=", "None", ...
Post an event to the Datadog stream. CLI Example .. code-block:: bash salt-call datadog.post_event api_key='0123456789' \\ app_key='9876543210' \\ title='Salt Highstate' \\ text="Salt highst...
[ "Post", "an", "event", "to", "the", "Datadog", "stream", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/datadog_api.py#L183-L264
train
saltstack/salt
salt/modules/xbpspkg.py
_get_version
def _get_version(): ''' Get the xbps version ''' version_string = __salt__['cmd.run']( [_check_xbps(), '--version'], output_loglevel='trace') if version_string is None: # Dunno why it would, but... return False VERSION_MATCH = re.compile(r'(?:XBPS:[\s]+)([\d.]+)(...
python
def _get_version(): ''' Get the xbps version ''' version_string = __salt__['cmd.run']( [_check_xbps(), '--version'], output_loglevel='trace') if version_string is None: # Dunno why it would, but... return False VERSION_MATCH = re.compile(r'(?:XBPS:[\s]+)([\d.]+)(...
[ "def", "_get_version", "(", ")", ":", "version_string", "=", "__salt__", "[", "'cmd.run'", "]", "(", "[", "_check_xbps", "(", ")", ",", "'--version'", "]", ",", "output_loglevel", "=", "'trace'", ")", "if", "version_string", "is", "None", ":", "# Dunno why i...
Get the xbps version
[ "Get", "the", "xbps", "version" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/xbpspkg.py#L51-L67
train
saltstack/salt
salt/modules/xbpspkg.py
list_pkgs
def list_pkgs(versions_as_list=False, **kwargs): ''' List the packages currently installed as a dict:: {'<package_name>': '<version>'} CLI Example: .. code-block:: bash salt '*' pkg.list_pkgs ''' versions_as_list = salt.utils.data.is_true(versions_as_list) # not yet imple...
python
def list_pkgs(versions_as_list=False, **kwargs): ''' List the packages currently installed as a dict:: {'<package_name>': '<version>'} CLI Example: .. code-block:: bash salt '*' pkg.list_pkgs ''' versions_as_list = salt.utils.data.is_true(versions_as_list) # not yet imple...
[ "def", "list_pkgs", "(", "versions_as_list", "=", "False", ",", "*", "*", "kwargs", ")", ":", "versions_as_list", "=", "salt", ".", "utils", ".", "data", ".", "is_true", "(", "versions_as_list", ")", "# not yet implemented or not applicable", "if", "any", "(", ...
List the packages currently installed as a dict:: {'<package_name>': '<version>'} CLI Example: .. code-block:: bash salt '*' pkg.list_pkgs
[ "List", "the", "packages", "currently", "installed", "as", "a", "dict", "::" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/xbpspkg.py#L81-L121
train
saltstack/salt
salt/modules/xbpspkg.py
list_upgrades
def list_upgrades(refresh=True, **kwargs): ''' Check whether or not an upgrade is available for all packages CLI Example: .. code-block:: bash salt '*' pkg.list_upgrades ''' # sample output of 'xbps-install -un': # fuse-2.9.4_4 update i686 http://repo.voidlinux.eu/current 298...
python
def list_upgrades(refresh=True, **kwargs): ''' Check whether or not an upgrade is available for all packages CLI Example: .. code-block:: bash salt '*' pkg.list_upgrades ''' # sample output of 'xbps-install -un': # fuse-2.9.4_4 update i686 http://repo.voidlinux.eu/current 298...
[ "def", "list_upgrades", "(", "refresh", "=", "True", ",", "*", "*", "kwargs", ")", ":", "# sample output of 'xbps-install -un':", "# fuse-2.9.4_4 update i686 http://repo.voidlinux.eu/current 298133 91688", "# xtools-0.34_1 update noarch http://repo.voidlinux.eu/current 21424 1075...
Check whether or not an upgrade is available for all packages CLI Example: .. code-block:: bash salt '*' pkg.list_upgrades
[ "Check", "whether", "or", "not", "an", "upgrade", "is", "available", "for", "all", "packages" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/xbpspkg.py#L124-L167
train
saltstack/salt
salt/modules/xbpspkg.py
refresh_db
def refresh_db(**kwargs): ''' Update list of available packages from installed repos CLI Example: .. code-block:: bash salt '*' pkg.refresh_db ''' # Remove rtag file to keep multiple refreshes from happening in pkg states salt.utils.pkg.clear_rtag(__opts__) cmd = 'xbps-install...
python
def refresh_db(**kwargs): ''' Update list of available packages from installed repos CLI Example: .. code-block:: bash salt '*' pkg.refresh_db ''' # Remove rtag file to keep multiple refreshes from happening in pkg states salt.utils.pkg.clear_rtag(__opts__) cmd = 'xbps-install...
[ "def", "refresh_db", "(", "*", "*", "kwargs", ")", ":", "# Remove rtag file to keep multiple refreshes from happening in pkg states", "salt", ".", "utils", ".", "pkg", ".", "clear_rtag", "(", "__opts__", ")", "cmd", "=", "'xbps-install -Sy'", "call", "=", "__salt__", ...
Update list of available packages from installed repos CLI Example: .. code-block:: bash salt '*' pkg.refresh_db
[ "Update", "list", "of", "available", "packages", "from", "installed", "repos" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/xbpspkg.py#L263-L284
train
saltstack/salt
salt/modules/xbpspkg.py
install
def install(name=None, refresh=False, fromrepo=None, pkgs=None, sources=None, **kwargs): ''' Install the passed package name The name of the package to be installed. refresh Whether or not to refresh the package database before installing. fromrepo Specify a pa...
python
def install(name=None, refresh=False, fromrepo=None, pkgs=None, sources=None, **kwargs): ''' Install the passed package name The name of the package to be installed. refresh Whether or not to refresh the package database before installing. fromrepo Specify a pa...
[ "def", "install", "(", "name", "=", "None", ",", "refresh", "=", "False", ",", "fromrepo", "=", "None", ",", "pkgs", "=", "None", ",", "sources", "=", "None", ",", "*", "*", "kwargs", ")", ":", "# XXX sources is not yet used in this code", "try", ":", "p...
Install the passed package name The name of the package to be installed. refresh Whether or not to refresh the package database before installing. fromrepo Specify a package repository (url) to install from. Multiple Package Installation Options: pkgs A list of ...
[ "Install", "the", "passed", "package" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/xbpspkg.py#L349-L430
train
saltstack/salt
salt/modules/xbpspkg.py
remove
def remove(name=None, pkgs=None, recursive=True, **kwargs): ''' name The name of the package to be deleted. recursive Also remove dependent packages (not required elsewhere). Default mode: enabled. Multiple Package Options: pkgs A list of packages to delete. Must b...
python
def remove(name=None, pkgs=None, recursive=True, **kwargs): ''' name The name of the package to be deleted. recursive Also remove dependent packages (not required elsewhere). Default mode: enabled. Multiple Package Options: pkgs A list of packages to delete. Must b...
[ "def", "remove", "(", "name", "=", "None", ",", "pkgs", "=", "None", ",", "recursive", "=", "True", ",", "*", "*", "kwargs", ")", ":", "try", ":", "pkg_params", ",", "pkg_type", "=", "__salt__", "[", "'pkg_resource.parse_targets'", "]", "(", "name", ",...
name The name of the package to be deleted. recursive Also remove dependent packages (not required elsewhere). Default mode: enabled. Multiple Package Options: pkgs A list of packages to delete. Must be passed as a python list. The ``name`` parameter will be ignore...
[ "name", "The", "name", "of", "the", "package", "to", "be", "deleted", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/xbpspkg.py#L433-L484
train
saltstack/salt
salt/modules/xbpspkg.py
list_repos
def list_repos(**kwargs): ''' List all repos known by XBPS CLI Example: .. code-block:: bash salt '*' pkg.list_repos ''' repos = {} out = __salt__['cmd.run']('xbps-query -L', output_loglevel='trace') for line in out.splitlines(): repo = {} if not line: ...
python
def list_repos(**kwargs): ''' List all repos known by XBPS CLI Example: .. code-block:: bash salt '*' pkg.list_repos ''' repos = {} out = __salt__['cmd.run']('xbps-query -L', output_loglevel='trace') for line in out.splitlines(): repo = {} if not line: ...
[ "def", "list_repos", "(", "*", "*", "kwargs", ")", ":", "repos", "=", "{", "}", "out", "=", "__salt__", "[", "'cmd.run'", "]", "(", "'xbps-query -L'", ",", "output_loglevel", "=", "'trace'", ")", "for", "line", "in", "out", ".", "splitlines", "(", ")",...
List all repos known by XBPS CLI Example: .. code-block:: bash salt '*' pkg.list_repos
[ "List", "all", "repos", "known", "by", "XBPS" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/xbpspkg.py#L487-L514
train
saltstack/salt
salt/modules/xbpspkg.py
_locate_repo_files
def _locate_repo_files(repo, rewrite=False): ''' Find what file a repo is called in. Helper function for add_repo() and del_repo() repo url of the repo to locate (persistent). rewrite Whether to remove matching repository settings during this process. Returns a list of absolu...
python
def _locate_repo_files(repo, rewrite=False): ''' Find what file a repo is called in. Helper function for add_repo() and del_repo() repo url of the repo to locate (persistent). rewrite Whether to remove matching repository settings during this process. Returns a list of absolu...
[ "def", "_locate_repo_files", "(", "repo", ",", "rewrite", "=", "False", ")", ":", "ret_val", "=", "[", "]", "files", "=", "[", "]", "conf_dirs", "=", "[", "'/etc/xbps.d/'", ",", "'/usr/share/xbps.d/'", "]", "name_glob", "=", "'*.conf'", "# Matches a line where...
Find what file a repo is called in. Helper function for add_repo() and del_repo() repo url of the repo to locate (persistent). rewrite Whether to remove matching repository settings during this process. Returns a list of absolute paths.
[ "Find", "what", "file", "a", "repo", "is", "called", "in", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/xbpspkg.py#L533-L575
train
saltstack/salt
salt/modules/xbpspkg.py
add_repo
def add_repo(repo, conffile='/usr/share/xbps.d/15-saltstack.conf'): ''' Add an XBPS repository to the system. repo url of repo to add (persistent). conffile path to xbps conf file to add this repo default: /usr/share/xbps.d/15-saltstack.conf CLI Examples: .. code-bloc...
python
def add_repo(repo, conffile='/usr/share/xbps.d/15-saltstack.conf'): ''' Add an XBPS repository to the system. repo url of repo to add (persistent). conffile path to xbps conf file to add this repo default: /usr/share/xbps.d/15-saltstack.conf CLI Examples: .. code-bloc...
[ "def", "add_repo", "(", "repo", ",", "conffile", "=", "'/usr/share/xbps.d/15-saltstack.conf'", ")", ":", "if", "not", "_locate_repo_files", "(", "repo", ")", ":", "try", ":", "with", "salt", ".", "utils", ".", "files", ".", "fopen", "(", "conffile", ",", "...
Add an XBPS repository to the system. repo url of repo to add (persistent). conffile path to xbps conf file to add this repo default: /usr/share/xbps.d/15-saltstack.conf CLI Examples: .. code-block:: bash salt '*' pkg.add_repo <repo url> [conffile=/path/to/xbps/repo....
[ "Add", "an", "XBPS", "repository", "to", "the", "system", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/xbpspkg.py#L578-L607
train
saltstack/salt
salt/modules/xbpspkg.py
del_repo
def del_repo(repo, **kwargs): ''' Remove an XBPS repository from the system. repo url of repo to remove (persistent). CLI Examples: .. code-block:: bash salt '*' pkg.del_repo <repo url> ''' try: _locate_repo_files(repo, rewrite=True) except IOError: r...
python
def del_repo(repo, **kwargs): ''' Remove an XBPS repository from the system. repo url of repo to remove (persistent). CLI Examples: .. code-block:: bash salt '*' pkg.del_repo <repo url> ''' try: _locate_repo_files(repo, rewrite=True) except IOError: r...
[ "def", "del_repo", "(", "repo", ",", "*", "*", "kwargs", ")", ":", "try", ":", "_locate_repo_files", "(", "repo", ",", "rewrite", "=", "True", ")", "except", "IOError", ":", "return", "False", "else", ":", "return", "True" ]
Remove an XBPS repository from the system. repo url of repo to remove (persistent). CLI Examples: .. code-block:: bash salt '*' pkg.del_repo <repo url>
[ "Remove", "an", "XBPS", "repository", "from", "the", "system", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/xbpspkg.py#L610-L629
train
saltstack/salt
salt/states/apache_conf.py
enabled
def enabled(name): ''' Ensure an Apache conf is enabled. name Name of the Apache conf ''' ret = {'name': name, 'result': True, 'comment': '', 'changes': {}} is_enabled = __salt__['apache.check_conf_enabled'](name) if not is_enabled: if __opts__['test']: msg = 'A...
python
def enabled(name): ''' Ensure an Apache conf is enabled. name Name of the Apache conf ''' ret = {'name': name, 'result': True, 'comment': '', 'changes': {}} is_enabled = __salt__['apache.check_conf_enabled'](name) if not is_enabled: if __opts__['test']: msg = 'A...
[ "def", "enabled", "(", "name", ")", ":", "ret", "=", "{", "'name'", ":", "name", ",", "'result'", ":", "True", ",", "'comment'", ":", "''", ",", "'changes'", ":", "{", "}", "}", "is_enabled", "=", "__salt__", "[", "'apache.check_conf_enabled'", "]", "(...
Ensure an Apache conf is enabled. name Name of the Apache conf
[ "Ensure", "an", "Apache", "conf", "is", "enabled", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/apache_conf.py#L33-L64
train
saltstack/salt
salt/modules/napalm_ntp.py
peers
def peers(**kwargs): # pylint: disable=unused-argument ''' Returns a list the NTP peers configured on the network device. :return: configured NTP peers as list. CLI Example: .. code-block:: bash salt '*' ntp.peers Example output: .. code-block:: python [ ...
python
def peers(**kwargs): # pylint: disable=unused-argument ''' Returns a list the NTP peers configured on the network device. :return: configured NTP peers as list. CLI Example: .. code-block:: bash salt '*' ntp.peers Example output: .. code-block:: python [ ...
[ "def", "peers", "(", "*", "*", "kwargs", ")", ":", "# pylint: disable=unused-argument", "ntp_peers", "=", "salt", ".", "utils", ".", "napalm", ".", "call", "(", "napalm_device", ",", "# pylint: disable=undefined-variable", "'get_ntp_peers'", ",", "*", "*", "{", ...
Returns a list the NTP peers configured on the network device. :return: configured NTP peers as list. CLI Example: .. code-block:: bash salt '*' ntp.peers Example output: .. code-block:: python [ '192.168.0.1', '172.17.17.1', '172.17.17.2', ...
[ "Returns", "a", "list", "the", "NTP", "peers", "configured", "on", "the", "network", "device", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/napalm_ntp.py#L63-L103
train
saltstack/salt
salt/modules/napalm_ntp.py
servers
def servers(**kwargs): # pylint: disable=unused-argument ''' Returns a list of the configured NTP servers on the device. CLI Example: .. code-block:: bash salt '*' ntp.servers Example output: .. code-block:: python [ '192.168.0.1', '172.17.17.1', ...
python
def servers(**kwargs): # pylint: disable=unused-argument ''' Returns a list of the configured NTP servers on the device. CLI Example: .. code-block:: bash salt '*' ntp.servers Example output: .. code-block:: python [ '192.168.0.1', '172.17.17.1', ...
[ "def", "servers", "(", "*", "*", "kwargs", ")", ":", "# pylint: disable=unused-argument", "ntp_servers", "=", "salt", ".", "utils", ".", "napalm", ".", "call", "(", "napalm_device", ",", "# pylint: disable=undefined-variable", "'get_ntp_servers'", ",", "*", "*", "...
Returns a list of the configured NTP servers on the device. CLI Example: .. code-block:: bash salt '*' ntp.servers Example output: .. code-block:: python [ '192.168.0.1', '172.17.17.1', '172.17.17.2', '2400:cb00:6:1024::c71b:840a' ...
[ "Returns", "a", "list", "of", "the", "configured", "NTP", "servers", "on", "the", "device", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/napalm_ntp.py#L107-L144
train
saltstack/salt
salt/modules/napalm_ntp.py
stats
def stats(peer=None, **kwargs): # pylint: disable=unused-argument ''' Returns a dictionary containing synchronization details of the NTP peers. :param peer: Returns only the details of a specific NTP peer. :return: a list of dictionaries, with the following keys: * remote * reference...
python
def stats(peer=None, **kwargs): # pylint: disable=unused-argument ''' Returns a dictionary containing synchronization details of the NTP peers. :param peer: Returns only the details of a specific NTP peer. :return: a list of dictionaries, with the following keys: * remote * reference...
[ "def", "stats", "(", "peer", "=", "None", ",", "*", "*", "kwargs", ")", ":", "# pylint: disable=unused-argument", "proxy_output", "=", "salt", ".", "utils", ".", "napalm", ".", "call", "(", "napalm_device", ",", "# pylint: disable=undefined-variable", "'get_ntp_st...
Returns a dictionary containing synchronization details of the NTP peers. :param peer: Returns only the details of a specific NTP peer. :return: a list of dictionaries, with the following keys: * remote * referenceid * synchronized * stratum * type * when ...
[ "Returns", "a", "dictionary", "containing", "synchronization", "details", "of", "the", "NTP", "peers", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/napalm_ntp.py#L148-L214
train
saltstack/salt
salt/modules/napalm_ntp.py
set_peers
def set_peers(*peers, **options): ''' Configures a list of NTP peers on the device. :param peers: list of IP Addresses/Domain Names :param test (bool): discard loaded config. By default ``test`` is False (will not dicard the changes) :commit commit (bool): commit loaded config. By default ...
python
def set_peers(*peers, **options): ''' Configures a list of NTP peers on the device. :param peers: list of IP Addresses/Domain Names :param test (bool): discard loaded config. By default ``test`` is False (will not dicard the changes) :commit commit (bool): commit loaded config. By default ...
[ "def", "set_peers", "(", "*", "peers", ",", "*", "*", "options", ")", ":", "test", "=", "options", ".", "pop", "(", "'test'", ",", "False", ")", "commit", "=", "options", ".", "pop", "(", "'commit'", ",", "True", ")", "return", "__salt__", "[", "'n...
Configures a list of NTP peers on the device. :param peers: list of IP Addresses/Domain Names :param test (bool): discard loaded config. By default ``test`` is False (will not dicard the changes) :commit commit (bool): commit loaded config. By default ``commit`` is True (will commit the cha...
[ "Configures", "a", "list", "of", "NTP", "peers", "on", "the", "device", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/napalm_ntp.py#L218-L249
train
saltstack/salt
salt/modules/napalm_ntp.py
delete_servers
def delete_servers(*servers, **options): ''' Removes NTP servers configured on the device. :param servers: list of IP Addresses/Domain Names to be removed as NTP servers :param test (bool): discard loaded config. By default ``test`` is False (will not dicard the changes) :param com...
python
def delete_servers(*servers, **options): ''' Removes NTP servers configured on the device. :param servers: list of IP Addresses/Domain Names to be removed as NTP servers :param test (bool): discard loaded config. By default ``test`` is False (will not dicard the changes) :param com...
[ "def", "delete_servers", "(", "*", "servers", ",", "*", "*", "options", ")", ":", "test", "=", "options", ".", "pop", "(", "'test'", ",", "False", ")", "commit", "=", "options", ".", "pop", "(", "'commit'", ",", "True", ")", "return", "__salt__", "["...
Removes NTP servers configured on the device. :param servers: list of IP Addresses/Domain Names to be removed as NTP servers :param test (bool): discard loaded config. By default ``test`` is False (will not dicard the changes) :param commit (bool): commit loaded config. By default ``commit`...
[ "Removes", "NTP", "servers", "configured", "on", "the", "device", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/napalm_ntp.py#L323-L356
train
saltstack/salt
salt/returners/elasticsearch_return.py
returner
def returner(ret): ''' Process the return from Salt ''' job_fun = ret['fun'] job_fun_escaped = job_fun.replace('.', '_') job_id = ret['jid'] job_retcode = ret.get('retcode', 1) job_success = True if not job_retcode else False options = _get_options(ret) if job_fun in options['...
python
def returner(ret): ''' Process the return from Salt ''' job_fun = ret['fun'] job_fun_escaped = job_fun.replace('.', '_') job_id = ret['jid'] job_retcode = ret.get('retcode', 1) job_success = True if not job_retcode else False options = _get_options(ret) if job_fun in options['...
[ "def", "returner", "(", "ret", ")", ":", "job_fun", "=", "ret", "[", "'fun'", "]", "job_fun_escaped", "=", "job_fun", ".", "replace", "(", "'.'", ",", "'_'", ")", "job_id", "=", "ret", "[", "'jid'", "]", "job_retcode", "=", "ret", ".", "get", "(", ...
Process the return from Salt
[ "Process", "the", "return", "from", "Salt" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/returners/elasticsearch_return.py#L208-L331
train
saltstack/salt
salt/returners/elasticsearch_return.py
event_return
def event_return(events): ''' Return events to Elasticsearch Requires that the `event_return` configuration be set in master config. ''' options = _get_options() index = options['master_event_index'] doc_type = options['master_event_doc_type'] if options['index_date']: index =...
python
def event_return(events): ''' Return events to Elasticsearch Requires that the `event_return` configuration be set in master config. ''' options = _get_options() index = options['master_event_index'] doc_type = options['master_event_doc_type'] if options['index_date']: index =...
[ "def", "event_return", "(", "events", ")", ":", "options", "=", "_get_options", "(", ")", "index", "=", "options", "[", "'master_event_index'", "]", "doc_type", "=", "options", "[", "'master_event_doc_type'", "]", "if", "options", "[", "'index_date'", "]", ":"...
Return events to Elasticsearch Requires that the `event_return` configuration be set in master config.
[ "Return", "events", "to", "Elasticsearch" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/returners/elasticsearch_return.py#L334-L360
train
saltstack/salt
salt/returners/elasticsearch_return.py
save_load
def save_load(jid, load, minions=None): ''' Save the load to the specified jid id .. versionadded:: 2015.8.1 ''' options = _get_options() index = options['master_job_cache_index'] doc_type = options['master_job_cache_doc_type'] if options['index_date']: index = '{0}-{1}'.forma...
python
def save_load(jid, load, minions=None): ''' Save the load to the specified jid id .. versionadded:: 2015.8.1 ''' options = _get_options() index = options['master_job_cache_index'] doc_type = options['master_job_cache_doc_type'] if options['index_date']: index = '{0}-{1}'.forma...
[ "def", "save_load", "(", "jid", ",", "load", ",", "minions", "=", "None", ")", ":", "options", "=", "_get_options", "(", ")", "index", "=", "options", "[", "'master_job_cache_index'", "]", "doc_type", "=", "options", "[", "'master_job_cache_doc_type'", "]", ...
Save the load to the specified jid id .. versionadded:: 2015.8.1
[ "Save", "the", "load", "to", "the", "specified", "jid", "id" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/returners/elasticsearch_return.py#L370-L404
train
saltstack/salt
salt/returners/elasticsearch_return.py
get_load
def get_load(jid): ''' Return the load data that marks a specified jid .. versionadded:: 2015.8.1 ''' options = _get_options() index = options['master_job_cache_index'] doc_type = options['master_job_cache_doc_type'] if options['index_date']: index = '{0}-{1}'.format(index, ...
python
def get_load(jid): ''' Return the load data that marks a specified jid .. versionadded:: 2015.8.1 ''' options = _get_options() index = options['master_job_cache_index'] doc_type = options['master_job_cache_doc_type'] if options['index_date']: index = '{0}-{1}'.format(index, ...
[ "def", "get_load", "(", "jid", ")", ":", "options", "=", "_get_options", "(", ")", "index", "=", "options", "[", "'master_job_cache_index'", "]", "doc_type", "=", "options", "[", "'master_job_cache_doc_type'", "]", "if", "options", "[", "'index_date'", "]", ":...
Return the load data that marks a specified jid .. versionadded:: 2015.8.1
[ "Return", "the", "load", "data", "that", "marks", "a", "specified", "jid" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/returners/elasticsearch_return.py#L407-L428
train
saltstack/salt
salt/runners/manage.py
status
def status(output=True, tgt='*', tgt_type='glob', timeout=None, gather_job_timeout=None): ''' .. versionchanged:: 2017.7.0 The ``expr_form`` argument has been renamed to ``tgt_type``, earlier releases must use ``expr_form``. Print the status of all known salt minions CLI Example: ...
python
def status(output=True, tgt='*', tgt_type='glob', timeout=None, gather_job_timeout=None): ''' .. versionchanged:: 2017.7.0 The ``expr_form`` argument has been renamed to ``tgt_type``, earlier releases must use ``expr_form``. Print the status of all known salt minions CLI Example: ...
[ "def", "status", "(", "output", "=", "True", ",", "tgt", "=", "'*'", ",", "tgt_type", "=", "'glob'", ",", "timeout", "=", "None", ",", "gather_job_timeout", "=", "None", ")", ":", "ret", "=", "{", "}", "if", "not", "timeout", ":", "timeout", "=", "...
.. versionchanged:: 2017.7.0 The ``expr_form`` argument has been renamed to ``tgt_type``, earlier releases must use ``expr_form``. Print the status of all known salt minions CLI Example: .. code-block:: bash salt-run manage.status salt-run manage.status tgt="webservers" t...
[ "..", "versionchanged", "::", "2017", ".", "7", ".", "0", "The", "expr_form", "argument", "has", "been", "renamed", "to", "tgt_type", "earlier", "releases", "must", "use", "expr_form", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L71-L96
train
saltstack/salt
salt/runners/manage.py
key_regen
def key_regen(): ''' This routine is used to regenerate all keys in an environment. This is invasive! ALL KEYS IN THE SALT ENVIRONMENT WILL BE REGENERATED!! The key_regen routine sends a command out to minions to revoke the master key and remove all minion keys, it then removes all keys from the ma...
python
def key_regen(): ''' This routine is used to regenerate all keys in an environment. This is invasive! ALL KEYS IN THE SALT ENVIRONMENT WILL BE REGENERATED!! The key_regen routine sends a command out to minions to revoke the master key and remove all minion keys, it then removes all keys from the ma...
[ "def", "key_regen", "(", ")", ":", "client", "=", "salt", ".", "client", ".", "get_local_client", "(", "__opts__", "[", "'conf_file'", "]", ")", "try", ":", "client", ".", "cmd", "(", "'*'", ",", "'saltutil.regen_keys'", ")", "except", "SaltClientError", "...
This routine is used to regenerate all keys in an environment. This is invasive! ALL KEYS IN THE SALT ENVIRONMENT WILL BE REGENERATED!! The key_regen routine sends a command out to minions to revoke the master key and remove all minion keys, it then removes all keys from the master and prompts the user...
[ "This", "routine", "is", "used", "to", "regenerate", "all", "keys", "in", "an", "environment", ".", "This", "is", "invasive!", "ALL", "KEYS", "IN", "THE", "SALT", "ENVIRONMENT", "WILL", "BE", "REGENERATED!!" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L99-L148
train
saltstack/salt
salt/runners/manage.py
down
def down(removekeys=False, tgt='*', tgt_type='glob', timeout=None, gather_job_timeout=None): ''' .. versionchanged:: 2017.7.0 The ``expr_form`` argument has been renamed to ``tgt_type``, earlier releases must use ``expr_form``. Print a list of all the down or unresponsive salt minions O...
python
def down(removekeys=False, tgt='*', tgt_type='glob', timeout=None, gather_job_timeout=None): ''' .. versionchanged:: 2017.7.0 The ``expr_form`` argument has been renamed to ``tgt_type``, earlier releases must use ``expr_form``. Print a list of all the down or unresponsive salt minions O...
[ "def", "down", "(", "removekeys", "=", "False", ",", "tgt", "=", "'*'", ",", "tgt_type", "=", "'glob'", ",", "timeout", "=", "None", ",", "gather_job_timeout", "=", "None", ")", ":", "ret", "=", "status", "(", "output", "=", "False", ",", "tgt", "=",...
.. versionchanged:: 2017.7.0 The ``expr_form`` argument has been renamed to ``tgt_type``, earlier releases must use ``expr_form``. Print a list of all the down or unresponsive salt minions Optionally remove keys of down minions CLI Example: .. code-block:: bash salt-run manag...
[ "..", "versionchanged", "::", "2017", ".", "7", ".", "0", "The", "expr_form", "argument", "has", "been", "renamed", "to", "tgt_type", "earlier", "releases", "must", "use", "expr_form", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L151-L179
train
saltstack/salt
salt/runners/manage.py
up
def up(tgt='*', tgt_type='glob', timeout=None, gather_job_timeout=None): # pylint: disable=C0103 ''' .. versionchanged:: 2017.7.0 The ``expr_form`` argument has been renamed to ``tgt_type``, earlier releases must use ``expr_form``. Print a list of all of the minions that are up CLI Ex...
python
def up(tgt='*', tgt_type='glob', timeout=None, gather_job_timeout=None): # pylint: disable=C0103 ''' .. versionchanged:: 2017.7.0 The ``expr_form`` argument has been renamed to ``tgt_type``, earlier releases must use ``expr_form``. Print a list of all of the minions that are up CLI Ex...
[ "def", "up", "(", "tgt", "=", "'*'", ",", "tgt_type", "=", "'glob'", ",", "timeout", "=", "None", ",", "gather_job_timeout", "=", "None", ")", ":", "# pylint: disable=C0103", "ret", "=", "status", "(", "output", "=", "False", ",", "tgt", "=", "tgt", ",...
.. versionchanged:: 2017.7.0 The ``expr_form`` argument has been renamed to ``tgt_type``, earlier releases must use ``expr_form``. Print a list of all of the minions that are up CLI Example: .. code-block:: bash salt-run manage.up salt-run manage.up tgt="webservers" tgt_t...
[ "..", "versionchanged", "::", "2017", ".", "7", ".", "0", "The", "expr_form", "argument", "has", "been", "renamed", "to", "tgt_type", "earlier", "releases", "must", "use", "expr_form", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L182-L205
train
saltstack/salt
salt/runners/manage.py
list_state
def list_state(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according ...
python
def list_state(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according ...
[ "def", "list_state", "(", "subset", "=", "None", ",", "show_ip", "=", "False", ",", "show_ipv4", "=", "None", ")", ":", "show_ip", "=", "_show_ip_migration", "(", "show_ip", ",", "show_ipv4", ")", "# Always return 'present' for 0MQ for now", "# TODO: implement other...
.. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according to Salt's presence detection (no commands will be sent to minions) ...
[ "..", "versionadded", "::", "2015", ".", "8", ".", "0", "..", "versionchanged", "::", "2019", ".", "2", ".", "0", "The", "show_ipv4", "argument", "has", "been", "renamed", "to", "show_ip", "as", "it", "now", "includes", "IPv6", "addresses", "for", "IPv6"...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L220-L251
train
saltstack/salt
salt/runners/manage.py
list_not_state
def list_not_state(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up ac...
python
def list_not_state(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up ac...
[ "def", "list_not_state", "(", "subset", "=", "None", ",", "show_ip", "=", "False", ",", "show_ipv4", "=", "None", ")", ":", "show_ip", "=", "_show_ip_migration", "(", "show_ip", ",", "show_ipv4", ")", "connected", "=", "list_state", "(", "subset", "=", "No...
.. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up according to Salt's presence detection (no commands will be sent to minion...
[ "..", "versionadded", "::", "2015", ".", "8", ".", "0", "..", "versionchanged", "::", "2019", ".", "2", ".", "0", "The", "show_ipv4", "argument", "has", "been", "renamed", "to", "show_ip", "as", "it", "now", "includes", "IPv6", "addresses", "for", "IPv6"...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L254-L287
train
saltstack/salt
salt/runners/manage.py
present
def present(subset=None, show_ip=False, show_ipv4=None): ''' .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according to Salt's presence detection (...
python
def present(subset=None, show_ip=False, show_ipv4=None): ''' .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according to Salt's presence detection (...
[ "def", "present", "(", "subset", "=", "None", ",", "show_ip", "=", "False", ",", "show_ipv4", "=", "None", ")", ":", "show_ip", "=", "_show_ip_migration", "(", "show_ip", ",", "show_ipv4", ")", "return", "list_state", "(", "subset", "=", "subset", ",", "...
.. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according to Salt's presence detection (no commands will be sent to minions) subset : None Pass ...
[ "..", "versionchanged", "::", "2019", ".", "2", ".", "0", "The", "show_ipv4", "argument", "has", "been", "renamed", "to", "show_ip", "as", "it", "now", "includes", "IPv6", "addresses", "for", "IPv6", "-", "connected", "minions", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L290-L312
train
saltstack/salt
salt/runners/manage.py
not_present
def not_present(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.5.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up accor...
python
def not_present(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.5.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up accor...
[ "def", "not_present", "(", "subset", "=", "None", ",", "show_ip", "=", "False", ",", "show_ipv4", "=", "None", ")", ":", "show_ip", "=", "_show_ip_migration", "(", "show_ip", ",", "show_ipv4", ")", "return", "list_not_state", "(", "subset", "=", "subset", ...
.. versionadded:: 2015.5.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up according to Salt's presence detection (no commands will be sent) sub...
[ "..", "versionadded", "::", "2015", ".", "5", ".", "0", "..", "versionchanged", "::", "2019", ".", "2", ".", "0", "The", "show_ipv4", "argument", "has", "been", "renamed", "to", "show_ip", "as", "it", "now", "includes", "IPv6", "addresses", "for", "IPv6"...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L315-L338
train
saltstack/salt
salt/runners/manage.py
joined
def joined(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according to S...
python
def joined(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according to S...
[ "def", "joined", "(", "subset", "=", "None", ",", "show_ip", "=", "False", ",", "show_ipv4", "=", "None", ")", ":", "show_ip", "=", "_show_ip_migration", "(", "show_ip", ",", "show_ipv4", ")", "return", "list_state", "(", "subset", "=", "subset", ",", "s...
.. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according to Salt's presence detection (no commands will be sent to minions) ...
[ "..", "versionadded", "::", "2015", ".", "8", ".", "0", "..", "versionchanged", "::", "2019", ".", "2", ".", "0", "The", "show_ipv4", "argument", "has", "been", "renamed", "to", "show_ip", "as", "it", "now", "includes", "IPv6", "addresses", "for", "IPv6"...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L341-L364
train
saltstack/salt
salt/runners/manage.py
not_joined
def not_joined(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up accord...
python
def not_joined(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up accord...
[ "def", "not_joined", "(", "subset", "=", "None", ",", "show_ip", "=", "False", ",", "show_ipv4", "=", "None", ")", ":", "show_ip", "=", "_show_ip_migration", "(", "show_ip", ",", "show_ipv4", ")", "return", "list_not_state", "(", "subset", "=", "subset", "...
.. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up according to Salt's presence detection (no commands will be sent) sub...
[ "..", "versionadded", "::", "2015", ".", "8", ".", "0", "..", "versionchanged", "::", "2019", ".", "2", ".", "0", "The", "show_ipv4", "argument", "has", "been", "renamed", "to", "show_ip", "as", "it", "now", "includes", "IPv6", "addresses", "for", "IPv6"...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L367-L390
train
saltstack/salt
salt/runners/manage.py
allowed
def allowed(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according to ...
python
def allowed(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according to ...
[ "def", "allowed", "(", "subset", "=", "None", ",", "show_ip", "=", "False", ",", "show_ipv4", "=", "None", ")", ":", "show_ip", "=", "_show_ip_migration", "(", "show_ip", ",", "show_ipv4", ")", "return", "list_state", "(", "subset", "=", "subset", ",", "...
.. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according to Salt's presence detection (no commands will be sent to minions) ...
[ "..", "versionadded", "::", "2015", ".", "8", ".", "0", "..", "versionchanged", "::", "2019", ".", "2", ".", "0", "The", "show_ipv4", "argument", "has", "been", "renamed", "to", "show_ip", "as", "it", "now", "includes", "IPv6", "addresses", "for", "IPv6"...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L393-L416
train
saltstack/salt
salt/runners/manage.py
not_allowed
def not_allowed(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up accor...
python
def not_allowed(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up accor...
[ "def", "not_allowed", "(", "subset", "=", "None", ",", "show_ip", "=", "False", ",", "show_ipv4", "=", "None", ")", ":", "show_ip", "=", "_show_ip_migration", "(", "show_ip", ",", "show_ipv4", ")", "return", "list_not_state", "(", "subset", "=", "subset", ...
.. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up according to Salt's presence detection (no commands will be sent) sub...
[ "..", "versionadded", "::", "2015", ".", "8", ".", "0", "..", "versionchanged", "::", "2019", ".", "2", ".", "0", "The", "show_ipv4", "argument", "has", "been", "renamed", "to", "show_ip", "as", "it", "now", "includes", "IPv6", "addresses", "for", "IPv6"...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L419-L442
train
saltstack/salt
salt/runners/manage.py
alived
def alived(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according to S...
python
def alived(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according to S...
[ "def", "alived", "(", "subset", "=", "None", ",", "show_ip", "=", "False", ",", "show_ipv4", "=", "None", ")", ":", "show_ip", "=", "_show_ip_migration", "(", "show_ip", ",", "show_ipv4", ")", "return", "list_state", "(", "subset", "=", "subset", ",", "s...
.. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according to Salt's presence detection (no commands will be sent to minions) ...
[ "..", "versionadded", "::", "2015", ".", "8", ".", "0", "..", "versionchanged", "::", "2019", ".", "2", ".", "0", "The", "show_ipv4", "argument", "has", "been", "renamed", "to", "show_ip", "as", "it", "now", "includes", "IPv6", "addresses", "for", "IPv6"...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L445-L468
train
saltstack/salt
salt/runners/manage.py
not_alived
def not_alived(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up accord...
python
def not_alived(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up accord...
[ "def", "not_alived", "(", "subset", "=", "None", ",", "show_ip", "=", "False", ",", "show_ipv4", "=", "None", ")", ":", "show_ip", "=", "_show_ip_migration", "(", "show_ip", ",", "show_ipv4", ")", "return", "list_not_state", "(", "subset", "=", "subset", "...
.. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up according to Salt's presence detection (no commands will be sent) sub...
[ "..", "versionadded", "::", "2015", ".", "8", ".", "0", "..", "versionchanged", "::", "2019", ".", "2", ".", "0", "The", "show_ipv4", "argument", "has", "been", "renamed", "to", "show_ip", "as", "it", "now", "includes", "IPv6", "addresses", "for", "IPv6"...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L471-L494
train
saltstack/salt
salt/runners/manage.py
reaped
def reaped(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according to S...
python
def reaped(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according to S...
[ "def", "reaped", "(", "subset", "=", "None", ",", "show_ip", "=", "False", ",", "show_ipv4", "=", "None", ")", ":", "show_ip", "=", "_show_ip_migration", "(", "show_ip", ",", "show_ipv4", ")", "return", "list_state", "(", "subset", "=", "subset", ",", "s...
.. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are up according to Salt's presence detection (no commands will be sent to minions) ...
[ "..", "versionadded", "::", "2015", ".", "8", ".", "0", "..", "versionchanged", "::", "2019", ".", "2", ".", "0", "The", "show_ipv4", "argument", "has", "been", "renamed", "to", "show_ip", "as", "it", "now", "includes", "IPv6", "addresses", "for", "IPv6"...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L497-L520
train
saltstack/salt
salt/runners/manage.py
not_reaped
def not_reaped(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up accord...
python
def not_reaped(subset=None, show_ip=False, show_ipv4=None): ''' .. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up accord...
[ "def", "not_reaped", "(", "subset", "=", "None", ",", "show_ip", "=", "False", ",", "show_ipv4", "=", "None", ")", ":", "show_ip", "=", "_show_ip_migration", "(", "show_ip", ",", "show_ipv4", ")", "return", "list_not_state", "(", "subset", "=", "subset", "...
.. versionadded:: 2015.8.0 .. versionchanged:: 2019.2.0 The 'show_ipv4' argument has been renamed to 'show_ip' as it now includes IPv6 addresses for IPv6-connected minions. Print a list of all minions that are NOT up according to Salt's presence detection (no commands will be sent) sub...
[ "..", "versionadded", "::", "2015", ".", "8", ".", "0", "..", "versionchanged", "::", "2019", ".", "2", ".", "0", "The", "show_ipv4", "argument", "has", "been", "renamed", "to", "show_ip", "as", "it", "now", "includes", "IPv6", "addresses", "for", "IPv6"...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L523-L546
train
saltstack/salt
salt/runners/manage.py
safe_accept
def safe_accept(target, tgt_type='glob'): ''' .. versionchanged:: 2017.7.0 The ``expr_form`` argument has been renamed to ``tgt_type``, earlier releases must use ``expr_form``. Accept a minion's public key after checking the fingerprint over salt-ssh CLI Example: .. code-block:: b...
python
def safe_accept(target, tgt_type='glob'): ''' .. versionchanged:: 2017.7.0 The ``expr_form`` argument has been renamed to ``tgt_type``, earlier releases must use ``expr_form``. Accept a minion's public key after checking the fingerprint over salt-ssh CLI Example: .. code-block:: b...
[ "def", "safe_accept", "(", "target", ",", "tgt_type", "=", "'glob'", ")", ":", "salt_key", "=", "salt", ".", "key", ".", "Key", "(", "__opts__", ")", "ssh_client", "=", "salt", ".", "client", ".", "ssh", ".", "client", ".", "SSHClient", "(", ")", "re...
.. versionchanged:: 2017.7.0 The ``expr_form`` argument has been renamed to ``tgt_type``, earlier releases must use ``expr_form``. Accept a minion's public key after checking the fingerprint over salt-ssh CLI Example: .. code-block:: bash salt-run manage.safe_accept my_minion ...
[ "..", "versionchanged", "::", "2017", ".", "7", ".", "0", "The", "expr_form", "argument", "has", "been", "renamed", "to", "tgt_type", "earlier", "releases", "must", "use", "expr_form", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L549-L602
train
saltstack/salt
salt/runners/manage.py
versions
def versions(): ''' Check the version of active minions CLI Example: .. code-block:: bash salt-run manage.versions ''' ret = {} client = salt.client.get_local_client(__opts__['conf_file']) try: minions = client.cmd('*', 'test.version', timeout=__opts__['timeout']) ...
python
def versions(): ''' Check the version of active minions CLI Example: .. code-block:: bash salt-run manage.versions ''' ret = {} client = salt.client.get_local_client(__opts__['conf_file']) try: minions = client.cmd('*', 'test.version', timeout=__opts__['timeout']) ...
[ "def", "versions", "(", ")", ":", "ret", "=", "{", "}", "client", "=", "salt", ".", "client", ".", "get_local_client", "(", "__opts__", "[", "'conf_file'", "]", ")", "try", ":", "minions", "=", "client", ".", "cmd", "(", "'*'", ",", "'test.version'", ...
Check the version of active minions CLI Example: .. code-block:: bash salt-run manage.versions
[ "Check", "the", "version", "of", "active", "minions" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L605-L659
train
saltstack/salt
salt/runners/manage.py
bootstrap
def bootstrap(version='develop', script=None, hosts='', script_args='', roster='flat', ssh_user=None, ssh_password=None, ssh_priv_key=None, tmp_dir='/tmp/.bootstrap', http_backend='tornado'): ...
python
def bootstrap(version='develop', script=None, hosts='', script_args='', roster='flat', ssh_user=None, ssh_password=None, ssh_priv_key=None, tmp_dir='/tmp/.bootstrap', http_backend='tornado'): ...
[ "def", "bootstrap", "(", "version", "=", "'develop'", ",", "script", "=", "None", ",", "hosts", "=", "''", ",", "script_args", "=", "''", ",", "roster", "=", "'flat'", ",", "ssh_user", "=", "None", ",", "ssh_password", "=", "None", ",", "ssh_priv_key", ...
Bootstrap minions with salt-bootstrap version : develop Git tag of version to install script : https://bootstrap.saltstack.com URL containing the script to execute hosts Comma-separated hosts [example: hosts='host1.local,host2.local']. These hosts need to exist in the spec...
[ "Bootstrap", "minions", "with", "salt", "-", "bootstrap" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L662-L784
train
saltstack/salt
salt/runners/manage.py
bootstrap_psexec
def bootstrap_psexec(hosts='', master=None, version=None, arch='win32', installer_url=None, username=None, password=None): ''' Bootstrap Windows minions via PsExec. hosts Comma separated list of hosts to deploy the Windows Salt minion. master Address of the Salt ma...
python
def bootstrap_psexec(hosts='', master=None, version=None, arch='win32', installer_url=None, username=None, password=None): ''' Bootstrap Windows minions via PsExec. hosts Comma separated list of hosts to deploy the Windows Salt minion. master Address of the Salt ma...
[ "def", "bootstrap_psexec", "(", "hosts", "=", "''", ",", "master", "=", "None", ",", "version", "=", "None", ",", "arch", "=", "'win32'", ",", "installer_url", "=", "None", ",", "username", "=", "None", ",", "password", "=", "None", ")", ":", "if", "...
Bootstrap Windows minions via PsExec. hosts Comma separated list of hosts to deploy the Windows Salt minion. master Address of the Salt master passed as an argument to the installer. version Point release of installer to download. Defaults to the most recent. arch Arc...
[ "Bootstrap", "Windows", "minions", "via", "PsExec", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/manage.py#L787-L922
train
saltstack/salt
salt/modules/launchctl_service.py
_available_services
def _available_services(): ''' Return a dictionary of all available services on the system ''' available_services = dict() for launch_dir in _launchd_paths(): for root, dirs, files in salt.utils.path.os_walk(launch_dir): for filename in files: file_path = os.path....
python
def _available_services(): ''' Return a dictionary of all available services on the system ''' available_services = dict() for launch_dir in _launchd_paths(): for root, dirs, files in salt.utils.path.os_walk(launch_dir): for filename in files: file_path = os.path....
[ "def", "_available_services", "(", ")", ":", "available_services", "=", "dict", "(", ")", "for", "launch_dir", "in", "_launchd_paths", "(", ")", ":", "for", "root", ",", "dirs", ",", "files", "in", "salt", ".", "utils", ".", "path", ".", "os_walk", "(", ...
Return a dictionary of all available services on the system
[ "Return", "a", "dictionary", "of", "all", "available", "services", "on", "the", "system" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/launchctl_service.py#L77-L125
train
saltstack/salt
salt/modules/launchctl_service.py
_service_by_name
def _service_by_name(name): ''' Return the service info for a service by label, filename or path ''' services = _available_services() name = name.lower() if name in services: # Match on label return services[name] for service in six.itervalues(services): if service[...
python
def _service_by_name(name): ''' Return the service info for a service by label, filename or path ''' services = _available_services() name = name.lower() if name in services: # Match on label return services[name] for service in six.itervalues(services): if service[...
[ "def", "_service_by_name", "(", "name", ")", ":", "services", "=", "_available_services", "(", ")", "name", "=", "name", ".", "lower", "(", ")", "if", "name", "in", "services", ":", "# Match on label", "return", "services", "[", "name", "]", "for", "servic...
Return the service info for a service by label, filename or path
[ "Return", "the", "service", "info", "for", "a", "service", "by", "label", "filename", "or", "path" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/launchctl_service.py#L128-L148
train