partition stringclasses 3
values | func_name stringlengths 1 134 | docstring stringlengths 1 46.9k | path stringlengths 4 223 | original_string stringlengths 75 104k | code stringlengths 75 104k | docstring_tokens listlengths 1 1.97k | repo stringlengths 7 55 | language stringclasses 1
value | url stringlengths 87 315 | code_tokens listlengths 19 28.4k | sha stringlengths 40 40 |
|---|---|---|---|---|---|---|---|---|---|---|---|
train | salt_api | The main function for salt-api | salt/scripts.py | def salt_api():
'''
The main function for salt-api
'''
import salt.utils.process
salt.utils.process.notify_systemd()
import salt.cli.api
sapi = salt.cli.api.SaltAPI() # pylint: disable=E1120
sapi.start() | def salt_api():
'''
The main function for salt-api
'''
import salt.utils.process
salt.utils.process.notify_systemd()
import salt.cli.api
sapi = salt.cli.api.SaltAPI() # pylint: disable=E1120
sapi.start() | [
"The",
"main",
"function",
"for",
"salt",
"-",
"api"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/scripts.py#L502-L511 | [
"def",
"salt_api",
"(",
")",
":",
"import",
"salt",
".",
"utils",
".",
"process",
"salt",
".",
"utils",
".",
"process",
".",
"notify_systemd",
"(",
")",
"import",
"salt",
".",
"cli",
".",
"api",
"sapi",
"=",
"salt",
".",
"cli",
".",
"api",
".",
"Sa... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | salt_main | Publish commands to the salt system from the command line on the
master. | salt/scripts.py | def salt_main():
'''
Publish commands to the salt system from the command line on the
master.
'''
import salt.cli.salt
if '' in sys.path:
sys.path.remove('')
client = salt.cli.salt.SaltCMD()
_install_signal_handlers(client)
client.run() | def salt_main():
'''
Publish commands to the salt system from the command line on the
master.
'''
import salt.cli.salt
if '' in sys.path:
sys.path.remove('')
client = salt.cli.salt.SaltCMD()
_install_signal_handlers(client)
client.run() | [
"Publish",
"commands",
"to",
"the",
"salt",
"system",
"from",
"the",
"command",
"line",
"on",
"the",
"master",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/scripts.py#L514-L524 | [
"def",
"salt_main",
"(",
")",
":",
"import",
"salt",
".",
"cli",
".",
"salt",
"if",
"''",
"in",
"sys",
".",
"path",
":",
"sys",
".",
"path",
".",
"remove",
"(",
"''",
")",
"client",
"=",
"salt",
".",
"cli",
".",
"salt",
".",
"SaltCMD",
"(",
")"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | salt_spm | The main function for spm, the Salt Package Manager
.. versionadded:: 2015.8.0 | salt/scripts.py | def salt_spm():
'''
The main function for spm, the Salt Package Manager
.. versionadded:: 2015.8.0
'''
import salt.cli.spm
spm = salt.cli.spm.SPM() # pylint: disable=E1120
spm.run() | def salt_spm():
'''
The main function for spm, the Salt Package Manager
.. versionadded:: 2015.8.0
'''
import salt.cli.spm
spm = salt.cli.spm.SPM() # pylint: disable=E1120
spm.run() | [
"The",
"main",
"function",
"for",
"spm",
"the",
"Salt",
"Package",
"Manager"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/scripts.py#L527-L535 | [
"def",
"salt_spm",
"(",
")",
":",
"import",
"salt",
".",
"cli",
".",
"spm",
"spm",
"=",
"salt",
".",
"cli",
".",
"spm",
".",
"SPM",
"(",
")",
"# pylint: disable=E1120",
"spm",
".",
"run",
"(",
")"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | salt_extend | Quickstart for developing on the saltstack installation
.. versionadded:: 2016.11.0 | salt/scripts.py | def salt_extend(extension, name, description, salt_dir, merge):
'''
Quickstart for developing on the saltstack installation
.. versionadded:: 2016.11.0
'''
import salt.utils.extend
salt.utils.extend.run(extension=extension,
name=name,
descript... | def salt_extend(extension, name, description, salt_dir, merge):
'''
Quickstart for developing on the saltstack installation
.. versionadded:: 2016.11.0
'''
import salt.utils.extend
salt.utils.extend.run(extension=extension,
name=name,
descript... | [
"Quickstart",
"for",
"developing",
"on",
"the",
"saltstack",
"installation"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/scripts.py#L538-L549 | [
"def",
"salt_extend",
"(",
"extension",
",",
"name",
",",
"description",
",",
"salt_dir",
",",
"merge",
")",
":",
"import",
"salt",
".",
"utils",
".",
"extend",
"salt",
".",
"utils",
".",
"extend",
".",
"run",
"(",
"extension",
"=",
"extension",
",",
"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | salt_support | Run Salt Support that collects system data, logs etc for debug and support purposes.
:return: | salt/scripts.py | def salt_support():
'''
Run Salt Support that collects system data, logs etc for debug and support purposes.
:return:
'''
import salt.cli.support.collector
if '' in sys.path:
sys.path.remove('')
client = salt.cli.support.collector.SaltSupport()
_install_signal_handlers(client)
... | def salt_support():
'''
Run Salt Support that collects system data, logs etc for debug and support purposes.
:return:
'''
import salt.cli.support.collector
if '' in sys.path:
sys.path.remove('')
client = salt.cli.support.collector.SaltSupport()
_install_signal_handlers(client)
... | [
"Run",
"Salt",
"Support",
"that",
"collects",
"system",
"data",
"logs",
"etc",
"for",
"debug",
"and",
"support",
"purposes",
".",
":",
"return",
":"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/scripts.py#L552-L563 | [
"def",
"salt_support",
"(",
")",
":",
"import",
"salt",
".",
"cli",
".",
"support",
".",
"collector",
"if",
"''",
"in",
"sys",
".",
"path",
":",
"sys",
".",
"path",
".",
"remove",
"(",
"''",
")",
"client",
"=",
"salt",
".",
"cli",
".",
"support",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | ext_pillar | Execute an unmodified puppet_node_classifier and read the output as YAML | salt/pillar/puppet.py | def ext_pillar(minion_id,
pillar, # pylint: disable=W0613
command):
'''
Execute an unmodified puppet_node_classifier and read the output as YAML
'''
try:
data = salt.utils.yaml.safe_load(__salt__['cmd.run']('{0} {1}'.format(command, minion_id)))
return data... | def ext_pillar(minion_id,
pillar, # pylint: disable=W0613
command):
'''
Execute an unmodified puppet_node_classifier and read the output as YAML
'''
try:
data = salt.utils.yaml.safe_load(__salt__['cmd.run']('{0} {1}'.format(command, minion_id)))
return data... | [
"Execute",
"an",
"unmodified",
"puppet_node_classifier",
"and",
"read",
"the",
"output",
"as",
"YAML"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/pillar/puppet.py#L20-L31 | [
"def",
"ext_pillar",
"(",
"minion_id",
",",
"pillar",
",",
"# pylint: disable=W0613",
"command",
")",
":",
"try",
":",
"data",
"=",
"salt",
".",
"utils",
".",
"yaml",
".",
"safe_load",
"(",
"__salt__",
"[",
"'cmd.run'",
"]",
"(",
"'{0} {1}'",
".",
"format"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _pshell_json | Execute the desired powershell command and ensure that it returns data
in JSON format and load that into python | salt/modules/win_wusa.py | def _pshell_json(cmd, cwd=None):
'''
Execute the desired powershell command and ensure that it returns data
in JSON format and load that into python
'''
if 'convertto-json' not in cmd.lower():
cmd = '{0} | ConvertTo-Json'.format(cmd)
log.debug('PowerShell: %s', cmd)
ret = __salt__['c... | def _pshell_json(cmd, cwd=None):
'''
Execute the desired powershell command and ensure that it returns data
in JSON format and load that into python
'''
if 'convertto-json' not in cmd.lower():
cmd = '{0} | ConvertTo-Json'.format(cmd)
log.debug('PowerShell: %s', cmd)
ret = __salt__['c... | [
"Execute",
"the",
"desired",
"powershell",
"command",
"and",
"ensure",
"that",
"it",
"returns",
"data",
"in",
"JSON",
"format",
"and",
"load",
"that",
"into",
"python"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_wusa.py#L41-L73 | [
"def",
"_pshell_json",
"(",
"cmd",
",",
"cwd",
"=",
"None",
")",
":",
"if",
"'convertto-json'",
"not",
"in",
"cmd",
".",
"lower",
"(",
")",
":",
"cmd",
"=",
"'{0} | ConvertTo-Json'",
".",
"format",
"(",
"cmd",
")",
"log",
".",
"debug",
"(",
"'PowerShel... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | install | Install a KB from a .msu file.
Args:
path (str):
The full path to the msu file to install
restart (bool):
``True`` to force a restart if required by the installation. Adds
the ``/forcerestart`` switch to the ``wusa.exe`` command. ``False``
will add ... | salt/modules/win_wusa.py | def install(path, restart=False):
'''
Install a KB from a .msu file.
Args:
path (str):
The full path to the msu file to install
restart (bool):
``True`` to force a restart if required by the installation. Adds
the ``/forcerestart`` switch to the ``wusa.... | def install(path, restart=False):
'''
Install a KB from a .msu file.
Args:
path (str):
The full path to the msu file to install
restart (bool):
``True`` to force a restart if required by the installation. Adds
the ``/forcerestart`` switch to the ``wusa.... | [
"Install",
"a",
"KB",
"from",
"a",
".",
"msu",
"file",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_wusa.py#L99-L145 | [
"def",
"install",
"(",
"path",
",",
"restart",
"=",
"False",
")",
":",
"# Build the command",
"cmd",
"=",
"[",
"'wusa.exe'",
",",
"path",
",",
"'/quiet'",
"]",
"if",
"restart",
":",
"cmd",
".",
"append",
"(",
"'/forcerestart'",
")",
"else",
":",
"cmd",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | uninstall | Uninstall a specific KB.
Args:
path (str):
The full path to the msu file to uninstall. This can also be just
the name of the KB to uninstall
restart (bool):
``True`` to force a restart if required by the installation. Adds
the ``/forcerestart`` swit... | salt/modules/win_wusa.py | def uninstall(path, restart=False):
'''
Uninstall a specific KB.
Args:
path (str):
The full path to the msu file to uninstall. This can also be just
the name of the KB to uninstall
restart (bool):
``True`` to force a restart if required by the installat... | def uninstall(path, restart=False):
'''
Uninstall a specific KB.
Args:
path (str):
The full path to the msu file to uninstall. This can also be just
the name of the KB to uninstall
restart (bool):
``True`` to force a restart if required by the installat... | [
"Uninstall",
"a",
"specific",
"KB",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_wusa.py#L148-L206 | [
"def",
"uninstall",
"(",
"path",
",",
"restart",
"=",
"False",
")",
":",
"# Build the command",
"cmd",
"=",
"[",
"'wusa.exe'",
",",
"'/uninstall'",
",",
"'/quiet'",
"]",
"kb",
"=",
"os",
".",
"path",
".",
"splitext",
"(",
"os",
".",
"path",
".",
"basen... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | list | Get a list of updates installed on the machine
Returns:
list: A list of installed updates
CLI Example:
.. code-block:: bash
salt '*' wusa.list | salt/modules/win_wusa.py | def list():
'''
Get a list of updates installed on the machine
Returns:
list: A list of installed updates
CLI Example:
.. code-block:: bash
salt '*' wusa.list
'''
kbs = []
ret = _pshell_json('Get-HotFix | Select HotFixID')
for item in ret:
kbs.append(item[... | def list():
'''
Get a list of updates installed on the machine
Returns:
list: A list of installed updates
CLI Example:
.. code-block:: bash
salt '*' wusa.list
'''
kbs = []
ret = _pshell_json('Get-HotFix | Select HotFixID')
for item in ret:
kbs.append(item[... | [
"Get",
"a",
"list",
"of",
"updates",
"installed",
"on",
"the",
"machine"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_wusa.py#L209-L226 | [
"def",
"list",
"(",
")",
":",
"kbs",
"=",
"[",
"]",
"ret",
"=",
"_pshell_json",
"(",
"'Get-HotFix | Select HotFixID'",
")",
"for",
"item",
"in",
"ret",
":",
"kbs",
".",
"append",
"(",
"item",
"[",
"'HotFixID'",
"]",
")",
"return",
"kbs"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | managed | Manage the device configuration given the input data structured
according to the YANG models.
data
YANG structured data.
models
A list of models to be used when generating the config.
profiles: ``None``
Use certain profiles to generate the config.
If not specified, wi... | salt/states/net_napalm_yang.py | def managed(name,
data,
**kwargs):
'''
Manage the device configuration given the input data structured
according to the YANG models.
data
YANG structured data.
models
A list of models to be used when generating the config.
profiles: ``None``
Us... | def managed(name,
data,
**kwargs):
'''
Manage the device configuration given the input data structured
according to the YANG models.
data
YANG structured data.
models
A list of models to be used when generating the config.
profiles: ``None``
Us... | [
"Manage",
"the",
"device",
"configuration",
"given",
"the",
"input",
"data",
"structured",
"according",
"to",
"the",
"YANG",
"models",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/net_napalm_yang.py#L78-L202 | [
"def",
"managed",
"(",
"name",
",",
"data",
",",
"*",
"*",
"kwargs",
")",
":",
"models",
"=",
"kwargs",
".",
"get",
"(",
"'models'",
",",
"None",
")",
"if",
"isinstance",
"(",
"models",
",",
"tuple",
")",
"and",
"isinstance",
"(",
"models",
"[",
"0... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | configured | Configure the network device, given the input data structured
according to the YANG models.
.. note::
The main difference between this function and ``managed``
is that the later generates and loads the configuration
only when there are differences between the existing
configurat... | salt/states/net_napalm_yang.py | def configured(name,
data,
**kwargs):
'''
Configure the network device, given the input data structured
according to the YANG models.
.. note::
The main difference between this function and ``managed``
is that the later generates and loads the configuration... | def configured(name,
data,
**kwargs):
'''
Configure the network device, given the input data structured
according to the YANG models.
.. note::
The main difference between this function and ``managed``
is that the later generates and loads the configuration... | [
"Configure",
"the",
"network",
"device",
"given",
"the",
"input",
"data",
"structured",
"according",
"to",
"the",
"YANG",
"models",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/net_napalm_yang.py#L205-L294 | [
"def",
"configured",
"(",
"name",
",",
"data",
",",
"*",
"*",
"kwargs",
")",
":",
"models",
"=",
"kwargs",
".",
"get",
"(",
"'models'",
",",
"None",
")",
"if",
"isinstance",
"(",
"models",
",",
"tuple",
")",
"and",
"isinstance",
"(",
"models",
"[",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _get_datacenter_name | Returns the datacenter name configured on the proxy
Supported proxies: esxcluster, esxdatacenter | salt/states/dvs.py | def _get_datacenter_name():
'''
Returns the datacenter name configured on the proxy
Supported proxies: esxcluster, esxdatacenter
'''
proxy_type = __salt__['vsphere.get_proxy_type']()
details = None
if proxy_type == 'esxcluster':
details = __salt__['esxcluster.get_details']()
el... | def _get_datacenter_name():
'''
Returns the datacenter name configured on the proxy
Supported proxies: esxcluster, esxdatacenter
'''
proxy_type = __salt__['vsphere.get_proxy_type']()
details = None
if proxy_type == 'esxcluster':
details = __salt__['esxcluster.get_details']()
el... | [
"Returns",
"the",
"datacenter",
"name",
"configured",
"on",
"the",
"proxy"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/dvs.py#L245-L261 | [
"def",
"_get_datacenter_name",
"(",
")",
":",
"proxy_type",
"=",
"__salt__",
"[",
"'vsphere.get_proxy_type'",
"]",
"(",
")",
"details",
"=",
"None",
"if",
"proxy_type",
"==",
"'esxcluster'",
":",
"details",
"=",
"__salt__",
"[",
"'esxcluster.get_details'",
"]",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | dvs_configured | Configures a DVS.
Creates a new DVS, if it doesn't exist in the provided datacenter or
reconfigures it if configured differently.
dvs
DVS dict representations (see module sysdocs) | salt/states/dvs.py | def dvs_configured(name, dvs):
'''
Configures a DVS.
Creates a new DVS, if it doesn't exist in the provided datacenter or
reconfigures it if configured differently.
dvs
DVS dict representations (see module sysdocs)
'''
datacenter_name = _get_datacenter_name()
dvs_name = dvs['na... | def dvs_configured(name, dvs):
'''
Configures a DVS.
Creates a new DVS, if it doesn't exist in the provided datacenter or
reconfigures it if configured differently.
dvs
DVS dict representations (see module sysdocs)
'''
datacenter_name = _get_datacenter_name()
dvs_name = dvs['na... | [
"Configures",
"a",
"DVS",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/dvs.py#L264-L407 | [
"def",
"dvs_configured",
"(",
"name",
",",
"dvs",
")",
":",
"datacenter_name",
"=",
"_get_datacenter_name",
"(",
")",
"dvs_name",
"=",
"dvs",
"[",
"'name'",
"]",
"if",
"dvs",
".",
"get",
"(",
"'name'",
")",
"else",
"name",
"log",
".",
"info",
"(",
"'Ru... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _get_diff_dict | Returns a dictionary with the diffs between two dictionaries
It will ignore any key that doesn't exist in dict2 | salt/states/dvs.py | def _get_diff_dict(dict1, dict2):
'''
Returns a dictionary with the diffs between two dictionaries
It will ignore any key that doesn't exist in dict2
'''
ret_dict = {}
for p in dict2.keys():
if p not in dict1:
ret_dict.update({p: {'val1': None, 'val2': dict2[p]}})
el... | def _get_diff_dict(dict1, dict2):
'''
Returns a dictionary with the diffs between two dictionaries
It will ignore any key that doesn't exist in dict2
'''
ret_dict = {}
for p in dict2.keys():
if p not in dict1:
ret_dict.update({p: {'val1': None, 'val2': dict2[p]}})
el... | [
"Returns",
"a",
"dictionary",
"with",
"the",
"diffs",
"between",
"two",
"dictionaries"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/dvs.py#L410-L427 | [
"def",
"_get_diff_dict",
"(",
"dict1",
",",
"dict2",
")",
":",
"ret_dict",
"=",
"{",
"}",
"for",
"p",
"in",
"dict2",
".",
"keys",
"(",
")",
":",
"if",
"p",
"not",
"in",
"dict1",
":",
"ret_dict",
".",
"update",
"(",
"{",
"p",
":",
"{",
"'val1'",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _get_val2_dict_from_diff_dict | Returns a dictionaries with the values stored in val2 of a diff dict. | salt/states/dvs.py | def _get_val2_dict_from_diff_dict(diff_dict):
'''
Returns a dictionaries with the values stored in val2 of a diff dict.
'''
ret_dict = {}
for p in diff_dict.keys():
if not isinstance(diff_dict[p], dict):
raise ValueError('Unexpected diff difct \'{0}\''.format(diff_dict))
... | def _get_val2_dict_from_diff_dict(diff_dict):
'''
Returns a dictionaries with the values stored in val2 of a diff dict.
'''
ret_dict = {}
for p in diff_dict.keys():
if not isinstance(diff_dict[p], dict):
raise ValueError('Unexpected diff difct \'{0}\''.format(diff_dict))
... | [
"Returns",
"a",
"dictionaries",
"with",
"the",
"values",
"stored",
"in",
"val2",
"of",
"a",
"diff",
"dict",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/dvs.py#L430-L443 | [
"def",
"_get_val2_dict_from_diff_dict",
"(",
"diff_dict",
")",
":",
"ret_dict",
"=",
"{",
"}",
"for",
"p",
"in",
"diff_dict",
".",
"keys",
"(",
")",
":",
"if",
"not",
"isinstance",
"(",
"diff_dict",
"[",
"p",
"]",
",",
"dict",
")",
":",
"raise",
"Value... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _get_changes_from_diff_dict | Returns a list of string message of the differences in a diff dict.
Each inner message is tabulated one tab deeper | salt/states/dvs.py | def _get_changes_from_diff_dict(diff_dict):
'''
Returns a list of string message of the differences in a diff dict.
Each inner message is tabulated one tab deeper
'''
changes_strings = []
for p in diff_dict.keys():
if not isinstance(diff_dict[p], dict):
raise ValueError('Une... | def _get_changes_from_diff_dict(diff_dict):
'''
Returns a list of string message of the differences in a diff dict.
Each inner message is tabulated one tab deeper
'''
changes_strings = []
for p in diff_dict.keys():
if not isinstance(diff_dict[p], dict):
raise ValueError('Une... | [
"Returns",
"a",
"list",
"of",
"string",
"message",
"of",
"the",
"differences",
"in",
"a",
"diff",
"dict",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/dvs.py#L462-L492 | [
"def",
"_get_changes_from_diff_dict",
"(",
"diff_dict",
")",
":",
"changes_strings",
"=",
"[",
"]",
"for",
"p",
"in",
"diff_dict",
".",
"keys",
"(",
")",
":",
"if",
"not",
"isinstance",
"(",
"diff_dict",
"[",
"p",
"]",
",",
"dict",
")",
":",
"raise",
"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | portgroups_configured | Configures portgroups on a DVS.
Creates/updates/removes portgroups in a provided DVS
dvs
Name of the DVS
portgroups
Portgroup dict representations (see module sysdocs) | salt/states/dvs.py | def portgroups_configured(name, dvs, portgroups):
'''
Configures portgroups on a DVS.
Creates/updates/removes portgroups in a provided DVS
dvs
Name of the DVS
portgroups
Portgroup dict representations (see module sysdocs)
'''
datacenter = _get_datacenter_name()
log.inf... | def portgroups_configured(name, dvs, portgroups):
'''
Configures portgroups on a DVS.
Creates/updates/removes portgroups in a provided DVS
dvs
Name of the DVS
portgroups
Portgroup dict representations (see module sysdocs)
'''
datacenter = _get_datacenter_name()
log.inf... | [
"Configures",
"portgroups",
"on",
"a",
"DVS",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/dvs.py#L495-L628 | [
"def",
"portgroups_configured",
"(",
"name",
",",
"dvs",
",",
"portgroups",
")",
":",
"datacenter",
"=",
"_get_datacenter_name",
"(",
")",
"log",
".",
"info",
"(",
"'Running state %s on DVS \\'%s\\', datacenter \\'%s\\''",
",",
"name",
",",
"dvs",
",",
"datacenter",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | uplink_portgroup_configured | Configures the uplink portgroup on a DVS. The state assumes there is only
one uplink portgroup.
dvs
Name of the DVS
upling_portgroup
Uplink portgroup dict representations (see module sysdocs) | salt/states/dvs.py | def uplink_portgroup_configured(name, dvs, uplink_portgroup):
'''
Configures the uplink portgroup on a DVS. The state assumes there is only
one uplink portgroup.
dvs
Name of the DVS
upling_portgroup
Uplink portgroup dict representations (see module sysdocs)
'''
datacenter ... | def uplink_portgroup_configured(name, dvs, uplink_portgroup):
'''
Configures the uplink portgroup on a DVS. The state assumes there is only
one uplink portgroup.
dvs
Name of the DVS
upling_portgroup
Uplink portgroup dict representations (see module sysdocs)
'''
datacenter ... | [
"Configures",
"the",
"uplink",
"portgroup",
"on",
"a",
"DVS",
".",
"The",
"state",
"assumes",
"there",
"is",
"only",
"one",
"uplink",
"portgroup",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/dvs.py#L631-L710 | [
"def",
"uplink_portgroup_configured",
"(",
"name",
",",
"dvs",
",",
"uplink_portgroup",
")",
":",
"datacenter",
"=",
"_get_datacenter_name",
"(",
")",
"log",
".",
"info",
"(",
"'Running %s on DVS \\'%s\\', datacenter \\'%s\\''",
",",
"name",
",",
"dvs",
",",
"datace... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | present | Ensure that the named user is present with the specified privileges
Please note that the user/group notion in postgresql is just abstract, we
have roles, where users can be seens as roles with the LOGIN privilege
and groups the others.
name
The name of the system user to manage.
createdb
... | salt/states/postgres_user.py | def present(name,
createdb=None,
createroles=None,
encrypted=None,
superuser=None,
replication=None,
inherit=None,
login=None,
password=None,
default_password=None,
refresh_password=None,
... | def present(name,
createdb=None,
createroles=None,
encrypted=None,
superuser=None,
replication=None,
inherit=None,
login=None,
password=None,
default_password=None,
refresh_password=None,
... | [
"Ensure",
"that",
"the",
"named",
"user",
"is",
"present",
"with",
"the",
"specified",
"privileges",
"Please",
"note",
"that",
"the",
"user",
"/",
"group",
"notion",
"in",
"postgresql",
"is",
"just",
"abstract",
"we",
"have",
"roles",
"where",
"users",
"can"... | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/postgres_user.py#L37-L259 | [
"def",
"present",
"(",
"name",
",",
"createdb",
"=",
"None",
",",
"createroles",
"=",
"None",
",",
"encrypted",
"=",
"None",
",",
"superuser",
"=",
"None",
",",
"replication",
"=",
"None",
",",
"inherit",
"=",
"None",
",",
"login",
"=",
"None",
",",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | property_present | Ensure property has a certain value
name : string
name of the zone
property : string
name of property
value : string
value of property | salt/states/zone.py | def property_present(name, property, value):
'''
Ensure property has a certain value
name : string
name of the zone
property : string
name of property
value : string
value of property
'''
ret = {'name': name,
'changes': {},
'result': None,
... | def property_present(name, property, value):
'''
Ensure property has a certain value
name : string
name of the zone
property : string
name of property
value : string
value of property
'''
ret = {'name': name,
'changes': {},
'result': None,
... | [
"Ensure",
"property",
"has",
"a",
"certain",
"value"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zone.py#L151-L199 | [
"def",
"property_present",
"(",
"name",
",",
"property",
",",
"value",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'changes'",
":",
"{",
"}",
",",
"'result'",
":",
"None",
",",
"'comment'",
":",
"''",
"}",
"## sanitize input",
"value",
"=",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | property_absent | Ensure property is absent
name : string
name of the zone
property : string
name of property
.. note::
This does a zoneacfg clear call. So the property may be reset to a default value!
Does has the side effect of always having to be called. | salt/states/zone.py | def property_absent(name, property):
'''
Ensure property is absent
name : string
name of the zone
property : string
name of property
.. note::
This does a zoneacfg clear call. So the property may be reset to a default value!
Does has the side effect of always having... | def property_absent(name, property):
'''
Ensure property is absent
name : string
name of the zone
property : string
name of property
.. note::
This does a zoneacfg clear call. So the property may be reset to a default value!
Does has the side effect of always having... | [
"Ensure",
"property",
"is",
"absent"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zone.py#L202-L253 | [
"def",
"property_absent",
"(",
"name",
",",
"property",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'changes'",
":",
"{",
"}",
",",
"'result'",
":",
"None",
",",
"'comment'",
":",
"''",
"}",
"zones",
"=",
"__salt__",
"[",
"'zoneadm.list'",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | resource_present | Ensure resource exists with provided properties
name : string
name of the zone
resource_type : string
type of resource
resource_selector_property : string
unique resource identifier
resource_selector_value : string
value for resource selection
kwargs : string|int|...... | salt/states/zone.py | def resource_present(name, resource_type, resource_selector_property, resource_selector_value, **kwargs):
'''
Ensure resource exists with provided properties
name : string
name of the zone
resource_type : string
type of resource
resource_selector_property : string
unique res... | def resource_present(name, resource_type, resource_selector_property, resource_selector_value, **kwargs):
'''
Ensure resource exists with provided properties
name : string
name of the zone
resource_type : string
type of resource
resource_selector_property : string
unique res... | [
"Ensure",
"resource",
"exists",
"with",
"provided",
"properties"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zone.py#L256-L414 | [
"def",
"resource_present",
"(",
"name",
",",
"resource_type",
",",
"resource_selector_property",
",",
"resource_selector_value",
",",
"*",
"*",
"kwargs",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'changes'",
":",
"{",
"}",
",",
"'result'",
":",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | resource_absent | Ensure resource is absent
name : string
name of the zone
resource_type : string
type of resource
resource_selector_property : string
unique resource identifier
resource_selector_value : string
value for resource selection
.. warning::
Both resource_selector_... | salt/states/zone.py | def resource_absent(name, resource_type, resource_selector_property, resource_selector_value):
'''
Ensure resource is absent
name : string
name of the zone
resource_type : string
type of resource
resource_selector_property : string
unique resource identifier
resource_sel... | def resource_absent(name, resource_type, resource_selector_property, resource_selector_value):
'''
Ensure resource is absent
name : string
name of the zone
resource_type : string
type of resource
resource_selector_property : string
unique resource identifier
resource_sel... | [
"Ensure",
"resource",
"is",
"absent"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zone.py#L417-L514 | [
"def",
"resource_absent",
"(",
"name",
",",
"resource_type",
",",
"resource_selector_property",
",",
"resource_selector_value",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'changes'",
":",
"{",
"}",
",",
"'result'",
":",
"None",
",",
"'comment'",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | booted | Ensure zone is booted
name : string
name of the zone
single : boolean
boot in single usermode | salt/states/zone.py | def booted(name, single=False):
'''
Ensure zone is booted
name : string
name of the zone
single : boolean
boot in single usermode
'''
ret = {'name': name,
'changes': {},
'result': None,
'comment': ''}
zones = __salt__['zoneadm.list'](instal... | def booted(name, single=False):
'''
Ensure zone is booted
name : string
name of the zone
single : boolean
boot in single usermode
'''
ret = {'name': name,
'changes': {},
'result': None,
'comment': ''}
zones = __salt__['zoneadm.list'](instal... | [
"Ensure",
"zone",
"is",
"booted"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zone.py#L517-L568 | [
"def",
"booted",
"(",
"name",
",",
"single",
"=",
"False",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'changes'",
":",
"{",
"}",
",",
"'result'",
":",
"None",
",",
"'comment'",
":",
"''",
"}",
"zones",
"=",
"__salt__",
"[",
"'zoneadm.l... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | halted | Ensure zone is halted
name : string
name of the zone
graceful : boolean
use shutdown instead of halt if true | salt/states/zone.py | def halted(name, graceful=True):
'''
Ensure zone is halted
name : string
name of the zone
graceful : boolean
use shutdown instead of halt if true
'''
ret = {'name': name,
'changes': {},
'result': None,
'comment': ''}
zones = __salt__['zonea... | def halted(name, graceful=True):
'''
Ensure zone is halted
name : string
name of the zone
graceful : boolean
use shutdown instead of halt if true
'''
ret = {'name': name,
'changes': {},
'result': None,
'comment': ''}
zones = __salt__['zonea... | [
"Ensure",
"zone",
"is",
"halted"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zone.py#L571-L622 | [
"def",
"halted",
"(",
"name",
",",
"graceful",
"=",
"True",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'changes'",
":",
"{",
"}",
",",
"'result'",
":",
"None",
",",
"'comment'",
":",
"''",
"}",
"zones",
"=",
"__salt__",
"[",
"'zoneadm.... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | export | Export a zones configuration
name : string
name of the zone
path : string
path of file to export too.
replace : boolean
replace the file if it exists | salt/states/zone.py | def export(name, path, replace=False):
'''
Export a zones configuration
name : string
name of the zone
path : string
path of file to export too.
replace : boolean
replace the file if it exists
'''
ret = {'name': name,
'changes': {},
'result': N... | def export(name, path, replace=False):
'''
Export a zones configuration
name : string
name of the zone
path : string
path of file to export too.
replace : boolean
replace the file if it exists
'''
ret = {'name': name,
'changes': {},
'result': N... | [
"Export",
"a",
"zones",
"configuration"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zone.py#L625-L738 | [
"def",
"export",
"(",
"name",
",",
"path",
",",
"replace",
"=",
"False",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'changes'",
":",
"{",
"}",
",",
"'result'",
":",
"None",
",",
"'comment'",
":",
"''",
"}",
"zones",
"=",
"__salt__",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | import_ | Import a zones configuration
name : string
name of the zone
path : string
path of the configuration file to import
mode : string
either import, install, or attach
nodataset : boolean
do not create a ZFS file system
brand_opts : boolean
brand specific options ... | salt/states/zone.py | def import_(name, path, mode='import', nodataset=False, brand_opts=None):
'''
Import a zones configuration
name : string
name of the zone
path : string
path of the configuration file to import
mode : string
either import, install, or attach
nodataset : boolean
do... | def import_(name, path, mode='import', nodataset=False, brand_opts=None):
'''
Import a zones configuration
name : string
name of the zone
path : string
path of the configuration file to import
mode : string
either import, install, or attach
nodataset : boolean
do... | [
"Import",
"a",
"zones",
"configuration"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zone.py#L741-L839 | [
"def",
"import_",
"(",
"name",
",",
"path",
",",
"mode",
"=",
"'import'",
",",
"nodataset",
"=",
"False",
",",
"brand_opts",
"=",
"None",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'changes'",
":",
"{",
"}",
",",
"'result'",
":",
"None... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | present | Ensure a zone with certain properties and resources
name : string
name of the zone
brand : string
brand of the zone
zonepath : string
path of the zone
properties : list of key-value pairs
dict of properties
resources : list of key-value pairs
dict of resource... | salt/states/zone.py | def present(name, brand, zonepath, properties=None, resources=None):
'''
Ensure a zone with certain properties and resources
name : string
name of the zone
brand : string
brand of the zone
zonepath : string
path of the zone
properties : list of key-value pairs
di... | def present(name, brand, zonepath, properties=None, resources=None):
'''
Ensure a zone with certain properties and resources
name : string
name of the zone
brand : string
brand of the zone
zonepath : string
path of the zone
properties : list of key-value pairs
di... | [
"Ensure",
"a",
"zone",
"with",
"certain",
"properties",
"and",
"resources"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zone.py#L842-L988 | [
"def",
"present",
"(",
"name",
",",
"brand",
",",
"zonepath",
",",
"properties",
"=",
"None",
",",
"resources",
"=",
"None",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'changes'",
":",
"{",
"}",
",",
"'result'",
":",
"None",
",",
"'com... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | absent | Ensure a zone is absent
name : string
name of the zone
uninstall : boolean
when true, uninstall instead of detaching the zone first. | salt/states/zone.py | def absent(name, uninstall=False):
'''
Ensure a zone is absent
name : string
name of the zone
uninstall : boolean
when true, uninstall instead of detaching the zone first.
'''
ret = {'name': name,
'changes': {},
'result': None,
'comment': ''}
... | def absent(name, uninstall=False):
'''
Ensure a zone is absent
name : string
name of the zone
uninstall : boolean
when true, uninstall instead of detaching the zone first.
'''
ret = {'name': name,
'changes': {},
'result': None,
'comment': ''}
... | [
"Ensure",
"a",
"zone",
"is",
"absent"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zone.py#L991-L1055 | [
"def",
"absent",
"(",
"name",
",",
"uninstall",
"=",
"False",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'changes'",
":",
"{",
"}",
",",
"'result'",
":",
"None",
",",
"'comment'",
":",
"''",
"}",
"zones",
"=",
"__salt__",
"[",
"'zonead... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | attached | Ensure zone is attached
name : string
name of the zone
force : boolean
force attach the zone | salt/states/zone.py | def attached(name, force=False):
'''
Ensure zone is attached
name : string
name of the zone
force : boolean
force attach the zone
'''
ret = {'name': name,
'changes': {},
'result': None,
'comment': ''}
zones = __salt__['zoneadm.list'](instal... | def attached(name, force=False):
'''
Ensure zone is attached
name : string
name of the zone
force : boolean
force attach the zone
'''
ret = {'name': name,
'changes': {},
'result': None,
'comment': ''}
zones = __salt__['zoneadm.list'](instal... | [
"Ensure",
"zone",
"is",
"attached"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zone.py#L1058-L1097 | [
"def",
"attached",
"(",
"name",
",",
"force",
"=",
"False",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'changes'",
":",
"{",
"}",
",",
"'result'",
":",
"None",
",",
"'comment'",
":",
"''",
"}",
"zones",
"=",
"__salt__",
"[",
"'zoneadm.... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | detached | Ensure zone is detached
name : string
name of the zone | salt/states/zone.py | def detached(name):
'''
Ensure zone is detached
name : string
name of the zone
'''
ret = {'name': name,
'changes': {},
'result': None,
'comment': ''}
zones = __salt__['zoneadm.list'](installed=True, configured=True)
if name in zones:
if zon... | def detached(name):
'''
Ensure zone is detached
name : string
name of the zone
'''
ret = {'name': name,
'changes': {},
'result': None,
'comment': ''}
zones = __salt__['zoneadm.list'](installed=True, configured=True)
if name in zones:
if zon... | [
"Ensure",
"zone",
"is",
"detached"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zone.py#L1100-L1138 | [
"def",
"detached",
"(",
"name",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'changes'",
":",
"{",
"}",
",",
"'result'",
":",
"None",
",",
"'comment'",
":",
"''",
"}",
"zones",
"=",
"__salt__",
"[",
"'zoneadm.list'",
"]",
"(",
"installed",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | installed | Ensure zone is installed
name : string
name of the zone
nodataset : boolean
do not create a ZFS file system
brand_opts : boolean
brand specific options to pass | salt/states/zone.py | def installed(name, nodataset=False, brand_opts=None):
'''
Ensure zone is installed
name : string
name of the zone
nodataset : boolean
do not create a ZFS file system
brand_opts : boolean
brand specific options to pass
'''
ret = {'name': name,
'changes': ... | def installed(name, nodataset=False, brand_opts=None):
'''
Ensure zone is installed
name : string
name of the zone
nodataset : boolean
do not create a ZFS file system
brand_opts : boolean
brand specific options to pass
'''
ret = {'name': name,
'changes': ... | [
"Ensure",
"zone",
"is",
"installed"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zone.py#L1141-L1182 | [
"def",
"installed",
"(",
"name",
",",
"nodataset",
"=",
"False",
",",
"brand_opts",
"=",
"None",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'changes'",
":",
"{",
"}",
",",
"'result'",
":",
"None",
",",
"'comment'",
":",
"''",
"}",
"zon... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | uninstalled | Ensure zone is uninstalled
name : string
name of the zone | salt/states/zone.py | def uninstalled(name):
'''
Ensure zone is uninstalled
name : string
name of the zone
'''
ret = {'name': name,
'changes': {},
'result': None,
'comment': ''}
zones = __salt__['zoneadm.list'](installed=True, configured=True)
if name in zones:
... | def uninstalled(name):
'''
Ensure zone is uninstalled
name : string
name of the zone
'''
ret = {'name': name,
'changes': {},
'result': None,
'comment': ''}
zones = __salt__['zoneadm.list'](installed=True, configured=True)
if name in zones:
... | [
"Ensure",
"zone",
"is",
"uninstalled"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zone.py#L1185-L1223 | [
"def",
"uninstalled",
"(",
"name",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'changes'",
":",
"{",
"}",
",",
"'result'",
":",
"None",
",",
"'comment'",
":",
"''",
"}",
"zones",
"=",
"__salt__",
"[",
"'zoneadm.list'",
"]",
"(",
"installe... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | validate | Validate the beacon configuration | salt/beacons/avahi_announce.py | def validate(config):
'''
Validate the beacon configuration
'''
_config = {}
list(map(_config.update, config))
if not isinstance(config, list):
return False, ('Configuration for avahi_announce '
'beacon must be a list.')
elif not all(x in _config for x in ('s... | def validate(config):
'''
Validate the beacon configuration
'''
_config = {}
list(map(_config.update, config))
if not isinstance(config, list):
return False, ('Configuration for avahi_announce '
'beacon must be a list.')
elif not all(x in _config for x in ('s... | [
"Validate",
"the",
"beacon",
"configuration"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/beacons/avahi_announce.py#L60-L76 | [
"def",
"validate",
"(",
"config",
")",
":",
"_config",
"=",
"{",
"}",
"list",
"(",
"map",
"(",
"_config",
".",
"update",
",",
"config",
")",
")",
"if",
"not",
"isinstance",
"(",
"config",
",",
"list",
")",
":",
"return",
"False",
",",
"(",
"'Config... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | beacon | Broadcast values via zeroconf
If the announced values are static, it is advised to set run_once: True
(do not poll) on the beacon configuration.
The following are required configuration settings:
- ``servicetype`` - The service type to announce
- ``port`` - The port of the service to announce
... | salt/beacons/avahi_announce.py | def beacon(config):
'''
Broadcast values via zeroconf
If the announced values are static, it is advised to set run_once: True
(do not poll) on the beacon configuration.
The following are required configuration settings:
- ``servicetype`` - The service type to announce
- ``port`` - The por... | def beacon(config):
'''
Broadcast values via zeroconf
If the announced values are static, it is advised to set run_once: True
(do not poll) on the beacon configuration.
The following are required configuration settings:
- ``servicetype`` - The service type to announce
- ``port`` - The por... | [
"Broadcast",
"values",
"via",
"zeroconf"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/beacons/avahi_announce.py#L99-L236 | [
"def",
"beacon",
"(",
"config",
")",
":",
"ret",
"=",
"[",
"]",
"changes",
"=",
"{",
"}",
"txt",
"=",
"{",
"}",
"global",
"LAST_GRAINS",
"_config",
"=",
"{",
"}",
"list",
"(",
"map",
"(",
"_config",
".",
"update",
",",
"config",
")",
")",
"if",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | war_deployed | Enforce that the WAR will be deployed and started in the context path,
while making use of WAR versions in the filename.
.. note::
For more info about Tomcats file paths and context naming, please see
http://tomcat.apache.org/tomcat-7.0-doc/config/context.html#Naming
name
The cont... | salt/states/tomcat.py | def war_deployed(name,
war,
force=False,
url='http://localhost:8080/manager',
timeout=180,
temp_war_location=None,
version=True):
'''
Enforce that the WAR will be deployed and started in the context path,
w... | def war_deployed(name,
war,
force=False,
url='http://localhost:8080/manager',
timeout=180,
temp_war_location=None,
version=True):
'''
Enforce that the WAR will be deployed and started in the context path,
w... | [
"Enforce",
"that",
"the",
"WAR",
"will",
"be",
"deployed",
"and",
"started",
"in",
"the",
"context",
"path",
"while",
"making",
"use",
"of",
"WAR",
"versions",
"in",
"the",
"filename",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/tomcat.py#L73-L222 | [
"def",
"war_deployed",
"(",
"name",
",",
"war",
",",
"force",
"=",
"False",
",",
"url",
"=",
"'http://localhost:8080/manager'",
",",
"timeout",
"=",
"180",
",",
"temp_war_location",
"=",
"None",
",",
"version",
"=",
"True",
")",
":",
"# Prepare",
"ret",
"=... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | wait | Wait for the Tomcat Manager to load.
Notice that if tomcat is not running we won't wait for it start and the
state will fail. This state can be required in the tomcat.war_deployed
state to make sure tomcat is running and that the manager is running as
well and ready for deployment.
url : http://lo... | salt/states/tomcat.py | def wait(name, url='http://localhost:8080/manager', timeout=180):
'''
Wait for the Tomcat Manager to load.
Notice that if tomcat is not running we won't wait for it start and the
state will fail. This state can be required in the tomcat.war_deployed
state to make sure tomcat is running and that the... | def wait(name, url='http://localhost:8080/manager', timeout=180):
'''
Wait for the Tomcat Manager to load.
Notice that if tomcat is not running we won't wait for it start and the
state will fail. This state can be required in the tomcat.war_deployed
state to make sure tomcat is running and that the... | [
"Wait",
"for",
"the",
"Tomcat",
"Manager",
"to",
"load",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/tomcat.py#L225-L270 | [
"def",
"wait",
"(",
"name",
",",
"url",
"=",
"'http://localhost:8080/manager'",
",",
"timeout",
"=",
"180",
")",
":",
"result",
"=",
"__salt__",
"[",
"'tomcat.status'",
"]",
"(",
"url",
",",
"timeout",
")",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | mod_watch | The tomcat watcher, called to invoke the watch command.
When called, it will reload the webapp in question
.. note::
This state exists to support special handling of the ``watch``
:ref:`requisite <requisites>`. It should not be called directly.
Parameters for this function should be se... | salt/states/tomcat.py | def mod_watch(name, url='http://localhost:8080/manager', timeout=180):
'''
The tomcat watcher, called to invoke the watch command.
When called, it will reload the webapp in question
.. note::
This state exists to support special handling of the ``watch``
:ref:`requisite <requisites>`. I... | def mod_watch(name, url='http://localhost:8080/manager', timeout=180):
'''
The tomcat watcher, called to invoke the watch command.
When called, it will reload the webapp in question
.. note::
This state exists to support special handling of the ``watch``
:ref:`requisite <requisites>`. I... | [
"The",
"tomcat",
"watcher",
"called",
"to",
"invoke",
"the",
"watch",
"command",
".",
"When",
"called",
"it",
"will",
"reload",
"the",
"webapp",
"in",
"question"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/tomcat.py#L273-L294 | [
"def",
"mod_watch",
"(",
"name",
",",
"url",
"=",
"'http://localhost:8080/manager'",
",",
"timeout",
"=",
"180",
")",
":",
"msg",
"=",
"__salt__",
"[",
"'tomcat.reload'",
"]",
"(",
"name",
",",
"url",
",",
"timeout",
")",
"result",
"=",
"msg",
".",
"star... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | undeployed | Enforce that the WAR will be undeployed from the server
name
The context path to undeploy.
url : http://localhost:8080/manager
The URL of the server with the Tomcat Manager webapp.
timeout : 180
Timeout for HTTP request to the Tomcat Manager.
Example:
.. code-block:: yaml
... | salt/states/tomcat.py | def undeployed(name,
url='http://localhost:8080/manager',
timeout=180):
'''
Enforce that the WAR will be undeployed from the server
name
The context path to undeploy.
url : http://localhost:8080/manager
The URL of the server with the Tomcat Manager webapp.
... | def undeployed(name,
url='http://localhost:8080/manager',
timeout=180):
'''
Enforce that the WAR will be undeployed from the server
name
The context path to undeploy.
url : http://localhost:8080/manager
The URL of the server with the Tomcat Manager webapp.
... | [
"Enforce",
"that",
"the",
"WAR",
"will",
"be",
"undeployed",
"from",
"the",
"server"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/tomcat.py#L297-L349 | [
"def",
"undeployed",
"(",
"name",
",",
"url",
"=",
"'http://localhost:8080/manager'",
",",
"timeout",
"=",
"180",
")",
":",
"# Prepare",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'result'",
":",
"True",
",",
"'changes'",
":",
"{",
"}",
",",
"'comment... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | send_msg | Send a message to an XMPP recipient. Designed for use in states.
CLI Examples:
.. code-block:: bash
xmpp.send_msg 'admins@xmpp.example.com' 'This is a salt module test' \
profile='my-xmpp-account'
xmpp.send_msg 'admins@xmpp.example.com' 'This is a salt module test' \
j... | salt/modules/xmpp.py | def send_msg(recipient, message, jid=None, password=None, profile=None):
'''
Send a message to an XMPP recipient. Designed for use in states.
CLI Examples:
.. code-block:: bash
xmpp.send_msg 'admins@xmpp.example.com' 'This is a salt module test' \
profile='my-xmpp-account'
... | def send_msg(recipient, message, jid=None, password=None, profile=None):
'''
Send a message to an XMPP recipient. Designed for use in states.
CLI Examples:
.. code-block:: bash
xmpp.send_msg 'admins@xmpp.example.com' 'This is a salt module test' \
profile='my-xmpp-account'
... | [
"Send",
"a",
"message",
"to",
"an",
"XMPP",
"recipient",
".",
"Designed",
"for",
"use",
"in",
"states",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/xmpp.py#L121-L146 | [
"def",
"send_msg",
"(",
"recipient",
",",
"message",
",",
"jid",
"=",
"None",
",",
"password",
"=",
"None",
",",
"profile",
"=",
"None",
")",
":",
"if",
"profile",
":",
"creds",
"=",
"__salt__",
"[",
"'config.option'",
"]",
"(",
"profile",
")",
"jid",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | send_msg_multi | Send a message to an XMPP recipient, support send message to
multiple recipients or chat room.
CLI Examples:
.. code-block:: bash
xmpp.send_msg recipients=['admins@xmpp.example.com'] \
rooms=['secret@conference.xmpp.example.com'] \
'This is a salt module test' \
... | salt/modules/xmpp.py | def send_msg_multi(message,
recipients=None,
rooms=None,
jid=None,
password=None,
nick="SaltStack Bot",
profile=None):
'''
Send a message to an XMPP recipient, support send message to
multiple r... | def send_msg_multi(message,
recipients=None,
rooms=None,
jid=None,
password=None,
nick="SaltStack Bot",
profile=None):
'''
Send a message to an XMPP recipient, support send message to
multiple r... | [
"Send",
"a",
"message",
"to",
"an",
"XMPP",
"recipient",
"support",
"send",
"message",
"to",
"multiple",
"recipients",
"or",
"chat",
"room",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/xmpp.py#L149-L197 | [
"def",
"send_msg_multi",
"(",
"message",
",",
"recipients",
"=",
"None",
",",
"rooms",
"=",
"None",
",",
"jid",
"=",
"None",
",",
"password",
"=",
"None",
",",
"nick",
"=",
"\"SaltStack Bot\"",
",",
"profile",
"=",
"None",
")",
":",
"# Remove: [WARNING ] U... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | SendMsgBot.create_multi | Alternate constructor that accept multiple recipients and rooms | salt/modules/xmpp.py | def create_multi(cls, jid, password, msg, recipients=None, rooms=None,
nick="SaltStack Bot"):
'''
Alternate constructor that accept multiple recipients and rooms
'''
obj = SendMsgBot(jid, password, None, msg)
obj.recipients = [] if recipients is None else rec... | def create_multi(cls, jid, password, msg, recipients=None, rooms=None,
nick="SaltStack Bot"):
'''
Alternate constructor that accept multiple recipients and rooms
'''
obj = SendMsgBot(jid, password, None, msg)
obj.recipients = [] if recipients is None else rec... | [
"Alternate",
"constructor",
"that",
"accept",
"multiple",
"recipients",
"and",
"rooms"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/xmpp.py#L90-L99 | [
"def",
"create_multi",
"(",
"cls",
",",
"jid",
",",
"password",
",",
"msg",
",",
"recipients",
"=",
"None",
",",
"rooms",
"=",
"None",
",",
"nick",
"=",
"\"SaltStack Bot\"",
")",
":",
"obj",
"=",
"SendMsgBot",
"(",
"jid",
",",
"password",
",",
"None",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | beacon | Emit a dict name "texts" whose value is a list
of texts.
.. code-block:: yaml
beacons:
twilio_txt_msg:
- account_sid: "<account sid>"
- auth_token: "<auth token>"
- twilio_number: "+15555555555"
- interval: 10 | salt/beacons/twilio_txt_msg.py | def beacon(config):
'''
Emit a dict name "texts" whose value is a list
of texts.
.. code-block:: yaml
beacons:
twilio_txt_msg:
- account_sid: "<account sid>"
- auth_token: "<auth token>"
- twilio_number: "+15555555555"
- interval: 10
... | def beacon(config):
'''
Emit a dict name "texts" whose value is a list
of texts.
.. code-block:: yaml
beacons:
twilio_txt_msg:
- account_sid: "<account sid>"
- auth_token: "<auth token>"
- twilio_number: "+15555555555"
- interval: 10
... | [
"Emit",
"a",
"dict",
"name",
"texts",
"whose",
"value",
"is",
"a",
"list",
"of",
"texts",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/beacons/twilio_txt_msg.py#L60-L111 | [
"def",
"beacon",
"(",
"config",
")",
":",
"log",
".",
"trace",
"(",
"'twilio_txt_msg beacon starting'",
")",
"_config",
"=",
"{",
"}",
"list",
"(",
"map",
"(",
"_config",
".",
"update",
",",
"config",
")",
")",
"ret",
"=",
"[",
"]",
"if",
"not",
"all... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | exists | Given a rule name, check to see if the given rule exists.
Returns True if the given rule exists and returns False if the given
rule does not exist.
CLI example::
salt myminion boto_cloudwatch_event.exists myevent region=us-east-1 | salt/modules/boto_cloudwatch_event.py | def exists(Name, region=None, key=None, keyid=None, profile=None):
'''
Given a rule name, check to see if the given rule exists.
Returns True if the given rule exists and returns False if the given
rule does not exist.
CLI example::
salt myminion boto_cloudwatch_event.exists myevent regio... | def exists(Name, region=None, key=None, keyid=None, profile=None):
'''
Given a rule name, check to see if the given rule exists.
Returns True if the given rule exists and returns False if the given
rule does not exist.
CLI example::
salt myminion boto_cloudwatch_event.exists myevent regio... | [
"Given",
"a",
"rule",
"name",
"check",
"to",
"see",
"if",
"the",
"given",
"rule",
"exists",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/boto_cloudwatch_event.py#L89-L112 | [
"def",
"exists",
"(",
"Name",
",",
"region",
"=",
"None",
",",
"key",
"=",
"None",
",",
"keyid",
"=",
"None",
",",
"profile",
"=",
"None",
")",
":",
"conn",
"=",
"_get_conn",
"(",
"region",
"=",
"region",
",",
"key",
"=",
"key",
",",
"keyid",
"="... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | create_or_update | Given a valid config, create an event rule.
Returns {created: true} if the rule was created and returns
{created: False} if the rule was not created.
CLI Example:
.. code-block:: bash
salt myminion boto_cloudwatch_event.create_or_update my_rule | salt/modules/boto_cloudwatch_event.py | def create_or_update(Name,
ScheduleExpression=None,
EventPattern=None,
Description=None,
RoleArn=None,
State=None,
region=None, key=None, keyid=None, profile=None):
'''
Given a valid config, create an event rule.
Returns {created: true} if t... | def create_or_update(Name,
ScheduleExpression=None,
EventPattern=None,
Description=None,
RoleArn=None,
State=None,
region=None, key=None, keyid=None, profile=None):
'''
Given a valid config, create an event rule.
Returns {created: true} if t... | [
"Given",
"a",
"valid",
"config",
"create",
"an",
"event",
"rule",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/boto_cloudwatch_event.py#L115-L153 | [
"def",
"create_or_update",
"(",
"Name",
",",
"ScheduleExpression",
"=",
"None",
",",
"EventPattern",
"=",
"None",
",",
"Description",
"=",
"None",
",",
"RoleArn",
"=",
"None",
",",
"State",
"=",
"None",
",",
"region",
"=",
"None",
",",
"key",
"=",
"None"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | describe | Given a rule name describe its properties.
Returns a dictionary of interesting properties.
CLI Example:
.. code-block:: bash
salt myminion boto_cloudwatch_event.describe myrule | salt/modules/boto_cloudwatch_event.py | def describe(Name,
region=None, key=None, keyid=None, profile=None):
'''
Given a rule name describe its properties.
Returns a dictionary of interesting properties.
CLI Example:
.. code-block:: bash
salt myminion boto_cloudwatch_event.describe myrule
'''
try:
... | def describe(Name,
region=None, key=None, keyid=None, profile=None):
'''
Given a rule name describe its properties.
Returns a dictionary of interesting properties.
CLI Example:
.. code-block:: bash
salt myminion boto_cloudwatch_event.describe myrule
'''
try:
... | [
"Given",
"a",
"rule",
"name",
"describe",
"its",
"properties",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/boto_cloudwatch_event.py#L180-L210 | [
"def",
"describe",
"(",
"Name",
",",
"region",
"=",
"None",
",",
"key",
"=",
"None",
",",
"keyid",
"=",
"None",
",",
"profile",
"=",
"None",
")",
":",
"try",
":",
"conn",
"=",
"_get_conn",
"(",
"region",
"=",
"region",
",",
"key",
"=",
"key",
","... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | list_rules | List, with details, all Cloudwatch Event rules visible in the current scope.
CLI example::
salt myminion boto_cloudwatch_event.list_rules region=us-east-1 | salt/modules/boto_cloudwatch_event.py | def list_rules(region=None, key=None, keyid=None, profile=None):
'''
List, with details, all Cloudwatch Event rules visible in the current scope.
CLI example::
salt myminion boto_cloudwatch_event.list_rules region=us-east-1
'''
conn = _get_conn(region=region, key=key, keyid=keyid, profile=... | def list_rules(region=None, key=None, keyid=None, profile=None):
'''
List, with details, all Cloudwatch Event rules visible in the current scope.
CLI example::
salt myminion boto_cloudwatch_event.list_rules region=us-east-1
'''
conn = _get_conn(region=region, key=key, keyid=keyid, profile=... | [
"List",
"with",
"details",
"all",
"Cloudwatch",
"Event",
"rules",
"visible",
"in",
"the",
"current",
"scope",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/boto_cloudwatch_event.py#L213-L233 | [
"def",
"list_rules",
"(",
"region",
"=",
"None",
",",
"key",
"=",
"None",
",",
"keyid",
"=",
"None",
",",
"profile",
"=",
"None",
")",
":",
"conn",
"=",
"_get_conn",
"(",
"region",
"=",
"region",
",",
"key",
"=",
"key",
",",
"keyid",
"=",
"keyid",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | list_targets | Given a rule name list the targets of that rule.
Returns a dictionary of interesting properties.
CLI Example:
.. code-block:: bash
salt myminion boto_cloudwatch_event.list_targets myrule | salt/modules/boto_cloudwatch_event.py | def list_targets(Rule,
region=None, key=None, keyid=None, profile=None):
'''
Given a rule name list the targets of that rule.
Returns a dictionary of interesting properties.
CLI Example:
.. code-block:: bash
salt myminion boto_cloudwatch_event.list_targets myrule
'''
... | def list_targets(Rule,
region=None, key=None, keyid=None, profile=None):
'''
Given a rule name list the targets of that rule.
Returns a dictionary of interesting properties.
CLI Example:
.. code-block:: bash
salt myminion boto_cloudwatch_event.list_targets myrule
'''
... | [
"Given",
"a",
"rule",
"name",
"list",
"the",
"targets",
"of",
"that",
"rule",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/boto_cloudwatch_event.py#L236-L266 | [
"def",
"list_targets",
"(",
"Rule",
",",
"region",
"=",
"None",
",",
"key",
"=",
"None",
",",
"keyid",
"=",
"None",
",",
"profile",
"=",
"None",
")",
":",
"try",
":",
"conn",
"=",
"_get_conn",
"(",
"region",
"=",
"region",
",",
"key",
"=",
"key",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | put_targets | Add the given targets to the given rule
Returns a dictionary describing any failures.
CLI Example:
.. code-block:: bash
salt myminion boto_cloudwatch_event.put_targets myrule [{'Id': 'target1', 'Arn': 'arn:***'}] | salt/modules/boto_cloudwatch_event.py | def put_targets(Rule, Targets,
region=None, key=None, keyid=None, profile=None):
'''
Add the given targets to the given rule
Returns a dictionary describing any failures.
CLI Example:
.. code-block:: bash
salt myminion boto_cloudwatch_event.put_targets myrule [{'Id': 'target... | def put_targets(Rule, Targets,
region=None, key=None, keyid=None, profile=None):
'''
Add the given targets to the given rule
Returns a dictionary describing any failures.
CLI Example:
.. code-block:: bash
salt myminion boto_cloudwatch_event.put_targets myrule [{'Id': 'target... | [
"Add",
"the",
"given",
"targets",
"to",
"the",
"given",
"rule"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/boto_cloudwatch_event.py#L269-L296 | [
"def",
"put_targets",
"(",
"Rule",
",",
"Targets",
",",
"region",
"=",
"None",
",",
"key",
"=",
"None",
",",
"keyid",
"=",
"None",
",",
"profile",
"=",
"None",
")",
":",
"try",
":",
"conn",
"=",
"_get_conn",
"(",
"region",
"=",
"region",
",",
"key"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _get_enabled_disabled | DRY: Get all service FMRIs and their enabled property | salt/modules/smf_service.py | def _get_enabled_disabled(enabled_prop="true"):
'''
DRY: Get all service FMRIs and their enabled property
'''
ret = set()
cmd = '/usr/bin/svcprop -c -p general/enabled "*"'
lines = __salt__['cmd.run_stdout'](cmd, python_shell=False).splitlines()
for line in lines:
comps = line.split(... | def _get_enabled_disabled(enabled_prop="true"):
'''
DRY: Get all service FMRIs and their enabled property
'''
ret = set()
cmd = '/usr/bin/svcprop -c -p general/enabled "*"'
lines = __salt__['cmd.run_stdout'](cmd, python_shell=False).splitlines()
for line in lines:
comps = line.split(... | [
"DRY",
":",
"Get",
"all",
"service",
"FMRIs",
"and",
"their",
"enabled",
"property"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/smf_service.py#L38-L51 | [
"def",
"_get_enabled_disabled",
"(",
"enabled_prop",
"=",
"\"true\"",
")",
":",
"ret",
"=",
"set",
"(",
")",
"cmd",
"=",
"'/usr/bin/svcprop -c -p general/enabled \"*\"'",
"lines",
"=",
"__salt__",
"[",
"'cmd.run_stdout'",
"]",
"(",
"cmd",
",",
"python_shell",
"=",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | available | Returns ``True`` if the specified service is available, otherwise returns
``False``.
We look up the name with the svcs command to get back the FMRI
This allows users to use simpler service names
CLI Example:
.. code-block:: bash
salt '*' service.available net-snmp | salt/modules/smf_service.py | def available(name):
'''
Returns ``True`` if the specified service is available, otherwise returns
``False``.
We look up the name with the svcs command to get back the FMRI
This allows users to use simpler service names
CLI Example:
.. code-block:: bash
salt '*' service.available... | def available(name):
'''
Returns ``True`` if the specified service is available, otherwise returns
``False``.
We look up the name with the svcs command to get back the FMRI
This allows users to use simpler service names
CLI Example:
.. code-block:: bash
salt '*' service.available... | [
"Returns",
"True",
"if",
"the",
"specified",
"service",
"is",
"available",
"otherwise",
"returns",
"False",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/smf_service.py#L98-L114 | [
"def",
"available",
"(",
"name",
")",
":",
"cmd",
"=",
"'/usr/bin/svcs -H -o FMRI {0}'",
".",
"format",
"(",
"name",
")",
"name",
"=",
"__salt__",
"[",
"'cmd.run'",
"]",
"(",
"cmd",
",",
"python_shell",
"=",
"False",
")",
"return",
"name",
"in",
"get_all",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | missing | The inverse of service.available.
Returns ``True`` if the specified service is not available, otherwise returns
``False``.
CLI Example:
.. code-block:: bash
salt '*' service.missing net-snmp | salt/modules/smf_service.py | def missing(name):
'''
The inverse of service.available.
Returns ``True`` if the specified service is not available, otherwise returns
``False``.
CLI Example:
.. code-block:: bash
salt '*' service.missing net-snmp
'''
cmd = '/usr/bin/svcs -H -o FMRI {0}'.format(name)
name ... | def missing(name):
'''
The inverse of service.available.
Returns ``True`` if the specified service is not available, otherwise returns
``False``.
CLI Example:
.. code-block:: bash
salt '*' service.missing net-snmp
'''
cmd = '/usr/bin/svcs -H -o FMRI {0}'.format(name)
name ... | [
"The",
"inverse",
"of",
"service",
".",
"available",
".",
"Returns",
"True",
"if",
"the",
"specified",
"service",
"is",
"not",
"available",
"otherwise",
"returns",
"False",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/smf_service.py#L117-L131 | [
"def",
"missing",
"(",
"name",
")",
":",
"cmd",
"=",
"'/usr/bin/svcs -H -o FMRI {0}'",
".",
"format",
"(",
"name",
")",
"name",
"=",
"__salt__",
"[",
"'cmd.run'",
"]",
"(",
"cmd",
",",
"python_shell",
"=",
"False",
")",
"return",
"name",
"not",
"in",
"ge... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | get_all | Return all installed services
CLI Example:
.. code-block:: bash
salt '*' service.get_all | salt/modules/smf_service.py | def get_all():
'''
Return all installed services
CLI Example:
.. code-block:: bash
salt '*' service.get_all
'''
ret = set()
cmd = '/usr/bin/svcs -aH -o FMRI,STATE -s FMRI'
lines = __salt__['cmd.run'](cmd).splitlines()
for line in lines:
comps = line.split()
... | def get_all():
'''
Return all installed services
CLI Example:
.. code-block:: bash
salt '*' service.get_all
'''
ret = set()
cmd = '/usr/bin/svcs -aH -o FMRI,STATE -s FMRI'
lines = __salt__['cmd.run'](cmd).splitlines()
for line in lines:
comps = line.split()
... | [
"Return",
"all",
"installed",
"services"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/smf_service.py#L134-L152 | [
"def",
"get_all",
"(",
")",
":",
"ret",
"=",
"set",
"(",
")",
"cmd",
"=",
"'/usr/bin/svcs -aH -o FMRI,STATE -s FMRI'",
"lines",
"=",
"__salt__",
"[",
"'cmd.run'",
"]",
"(",
"cmd",
")",
".",
"splitlines",
"(",
")",
"for",
"line",
"in",
"lines",
":",
"comp... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | start | Start the specified service
CLI Example:
.. code-block:: bash
salt '*' service.start <service name> | salt/modules/smf_service.py | def start(name):
'''
Start the specified service
CLI Example:
.. code-block:: bash
salt '*' service.start <service name>
'''
cmd = '/usr/sbin/svcadm enable -s -t {0}'.format(name)
retcode = __salt__['cmd.retcode'](cmd, python_shell=False)
if not retcode:
return True
... | def start(name):
'''
Start the specified service
CLI Example:
.. code-block:: bash
salt '*' service.start <service name>
'''
cmd = '/usr/sbin/svcadm enable -s -t {0}'.format(name)
retcode = __salt__['cmd.retcode'](cmd, python_shell=False)
if not retcode:
return True
... | [
"Start",
"the",
"specified",
"service"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/smf_service.py#L155-L176 | [
"def",
"start",
"(",
"name",
")",
":",
"cmd",
"=",
"'/usr/sbin/svcadm enable -s -t {0}'",
".",
"format",
"(",
"name",
")",
"retcode",
"=",
"__salt__",
"[",
"'cmd.retcode'",
"]",
"(",
"cmd",
",",
"python_shell",
"=",
"False",
")",
"if",
"not",
"retcode",
":... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | restart | Restart the named service
CLI Example:
.. code-block:: bash
salt '*' service.restart <service name> | salt/modules/smf_service.py | def restart(name):
'''
Restart the named service
CLI Example:
.. code-block:: bash
salt '*' service.restart <service name>
'''
cmd = '/usr/sbin/svcadm restart {0}'.format(name)
if not __salt__['cmd.retcode'](cmd, python_shell=False):
# calling restart doesn't clear mainten... | def restart(name):
'''
Restart the named service
CLI Example:
.. code-block:: bash
salt '*' service.restart <service name>
'''
cmd = '/usr/sbin/svcadm restart {0}'.format(name)
if not __salt__['cmd.retcode'](cmd, python_shell=False):
# calling restart doesn't clear mainten... | [
"Restart",
"the",
"named",
"service"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/smf_service.py#L193-L208 | [
"def",
"restart",
"(",
"name",
")",
":",
"cmd",
"=",
"'/usr/sbin/svcadm restart {0}'",
".",
"format",
"(",
"name",
")",
"if",
"not",
"__salt__",
"[",
"'cmd.retcode'",
"]",
"(",
"cmd",
",",
"python_shell",
"=",
"False",
")",
":",
"# calling restart doesn't clea... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | reload_ | Reload the named service
CLI Example:
.. code-block:: bash
salt '*' service.reload <service name> | salt/modules/smf_service.py | def reload_(name):
'''
Reload the named service
CLI Example:
.. code-block:: bash
salt '*' service.reload <service name>
'''
cmd = '/usr/sbin/svcadm refresh {0}'.format(name)
if not __salt__['cmd.retcode'](cmd, python_shell=False):
# calling reload doesn't clear maintenanc... | def reload_(name):
'''
Reload the named service
CLI Example:
.. code-block:: bash
salt '*' service.reload <service name>
'''
cmd = '/usr/sbin/svcadm refresh {0}'.format(name)
if not __salt__['cmd.retcode'](cmd, python_shell=False):
# calling reload doesn't clear maintenanc... | [
"Reload",
"the",
"named",
"service"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/smf_service.py#L211-L226 | [
"def",
"reload_",
"(",
"name",
")",
":",
"cmd",
"=",
"'/usr/sbin/svcadm refresh {0}'",
".",
"format",
"(",
"name",
")",
"if",
"not",
"__salt__",
"[",
"'cmd.retcode'",
"]",
"(",
"cmd",
",",
"python_shell",
"=",
"False",
")",
":",
"# calling reload doesn't clear... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | status | Return the status for a service.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.. versionchanged:: 2018.3.0
The service name can now be a glob (e.g. ``salt*``)
Args:
name (str): The name of the service to check
sig (str): Not imple... | salt/modules/smf_service.py | def status(name, sig=None):
'''
Return the status for a service.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.. versionchanged:: 2018.3.0
The service name can now be a glob (e.g. ``salt*``)
Args:
name (str): The name of the servi... | def status(name, sig=None):
'''
Return the status for a service.
If the name contains globbing, a dict mapping service name to True/False
values is returned.
.. versionchanged:: 2018.3.0
The service name can now be a glob (e.g. ``salt*``)
Args:
name (str): The name of the servi... | [
"Return",
"the",
"status",
"for",
"a",
"service",
".",
"If",
"the",
"name",
"contains",
"globbing",
"a",
"dict",
"mapping",
"service",
"name",
"to",
"True",
"/",
"False",
"values",
"is",
"returned",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/smf_service.py#L229-L264 | [
"def",
"status",
"(",
"name",
",",
"sig",
"=",
"None",
")",
":",
"contains_globbing",
"=",
"bool",
"(",
"re",
".",
"search",
"(",
"r'\\*|\\?|\\[.+\\]'",
",",
"name",
")",
")",
"if",
"contains_globbing",
":",
"services",
"=",
"fnmatch",
".",
"filter",
"("... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | enable | Enable the named service to start at boot
CLI Example:
.. code-block:: bash
salt '*' service.enable <service name> | salt/modules/smf_service.py | def enable(name, **kwargs):
'''
Enable the named service to start at boot
CLI Example:
.. code-block:: bash
salt '*' service.enable <service name>
'''
cmd = '/usr/sbin/svcadm enable {0}'.format(name)
return not __salt__['cmd.retcode'](cmd, python_shell=False) | def enable(name, **kwargs):
'''
Enable the named service to start at boot
CLI Example:
.. code-block:: bash
salt '*' service.enable <service name>
'''
cmd = '/usr/sbin/svcadm enable {0}'.format(name)
return not __salt__['cmd.retcode'](cmd, python_shell=False) | [
"Enable",
"the",
"named",
"service",
"to",
"start",
"at",
"boot"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/smf_service.py#L267-L278 | [
"def",
"enable",
"(",
"name",
",",
"*",
"*",
"kwargs",
")",
":",
"cmd",
"=",
"'/usr/sbin/svcadm enable {0}'",
".",
"format",
"(",
"name",
")",
"return",
"not",
"__salt__",
"[",
"'cmd.retcode'",
"]",
"(",
"cmd",
",",
"python_shell",
"=",
"False",
")"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | disable | Disable the named service to start at boot
CLI Example:
.. code-block:: bash
salt '*' service.disable <service name> | salt/modules/smf_service.py | def disable(name, **kwargs):
'''
Disable the named service to start at boot
CLI Example:
.. code-block:: bash
salt '*' service.disable <service name>
'''
cmd = '/usr/sbin/svcadm disable {0}'.format(name)
return not __salt__['cmd.retcode'](cmd, python_shell=False) | def disable(name, **kwargs):
'''
Disable the named service to start at boot
CLI Example:
.. code-block:: bash
salt '*' service.disable <service name>
'''
cmd = '/usr/sbin/svcadm disable {0}'.format(name)
return not __salt__['cmd.retcode'](cmd, python_shell=False) | [
"Disable",
"the",
"named",
"service",
"to",
"start",
"at",
"boot"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/smf_service.py#L281-L292 | [
"def",
"disable",
"(",
"name",
",",
"*",
"*",
"kwargs",
")",
":",
"cmd",
"=",
"'/usr/sbin/svcadm disable {0}'",
".",
"format",
"(",
"name",
")",
"return",
"not",
"__salt__",
"[",
"'cmd.retcode'",
"]",
"(",
"cmd",
",",
"python_shell",
"=",
"False",
")"
] | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | enabled | Check to see if the named service is enabled to start on boot
CLI Example:
.. code-block:: bash
salt '*' service.enabled <service name> | salt/modules/smf_service.py | def enabled(name, **kwargs):
'''
Check to see if the named service is enabled to start on boot
CLI Example:
.. code-block:: bash
salt '*' service.enabled <service name>
'''
# The property that reveals whether a service is enabled
# can only be queried using the full FMRI
# We ... | def enabled(name, **kwargs):
'''
Check to see if the named service is enabled to start on boot
CLI Example:
.. code-block:: bash
salt '*' service.enabled <service name>
'''
# The property that reveals whether a service is enabled
# can only be queried using the full FMRI
# We ... | [
"Check",
"to",
"see",
"if",
"the",
"named",
"service",
"is",
"enabled",
"to",
"start",
"on",
"boot"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/smf_service.py#L295-L315 | [
"def",
"enabled",
"(",
"name",
",",
"*",
"*",
"kwargs",
")",
":",
"# The property that reveals whether a service is enabled",
"# can only be queried using the full FMRI",
"# We extract the FMRI and then do the query",
"fmri_cmd",
"=",
"'/usr/bin/svcs -H -o FMRI {0}'",
".",
"format"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | upgrade_available | Check whether or not an upgrade is available for a given package
Args:
name (str): The name of a single package
Kwargs:
refresh (bool): Refresh package metadata. Default ``True``
saltenv (str): The salt environment. Default ``base``
Returns:
bool: True if new version avail... | salt/modules/win_pkg.py | def upgrade_available(name, **kwargs):
'''
Check whether or not an upgrade is available for a given package
Args:
name (str): The name of a single package
Kwargs:
refresh (bool): Refresh package metadata. Default ``True``
saltenv (str): The salt environment. Default ``base``
... | def upgrade_available(name, **kwargs):
'''
Check whether or not an upgrade is available for a given package
Args:
name (str): The name of a single package
Kwargs:
refresh (bool): Refresh package metadata. Default ``True``
saltenv (str): The salt environment. Default ``base``
... | [
"Check",
"whether",
"or",
"not",
"an",
"upgrade",
"is",
"available",
"for",
"a",
"given",
"package"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L187-L214 | [
"def",
"upgrade_available",
"(",
"name",
",",
"*",
"*",
"kwargs",
")",
":",
"saltenv",
"=",
"kwargs",
".",
"get",
"(",
"'saltenv'",
",",
"'base'",
")",
"# Refresh before looking for the latest version available,",
"# same default as latest_version",
"refresh",
"=",
"s... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | list_upgrades | List all available package upgrades on this system
Args:
refresh (bool): Refresh package metadata. Default ``True``
Kwargs:
saltenv (str): Salt environment. Default ``base``
Returns:
dict: A dictionary of packages with available upgrades
CLI Example:
.. code-block:: bash... | salt/modules/win_pkg.py | def list_upgrades(refresh=True, **kwargs):
'''
List all available package upgrades on this system
Args:
refresh (bool): Refresh package metadata. Default ``True``
Kwargs:
saltenv (str): Salt environment. Default ``base``
Returns:
dict: A dictionary of packages with availab... | def list_upgrades(refresh=True, **kwargs):
'''
List all available package upgrades on this system
Args:
refresh (bool): Refresh package metadata. Default ``True``
Kwargs:
saltenv (str): Salt environment. Default ``base``
Returns:
dict: A dictionary of packages with availab... | [
"List",
"all",
"available",
"package",
"upgrades",
"on",
"this",
"system"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L217-L254 | [
"def",
"list_upgrades",
"(",
"refresh",
"=",
"True",
",",
"*",
"*",
"kwargs",
")",
":",
"saltenv",
"=",
"kwargs",
".",
"get",
"(",
"'saltenv'",
",",
"'base'",
")",
"refresh",
"=",
"salt",
".",
"utils",
".",
"data",
".",
"is_true",
"(",
"refresh",
")"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | list_available | Return a list of available versions of the specified package.
Args:
names (str): One or more package names
Kwargs:
saltenv (str): The salt environment to use. Default ``base``.
refresh (bool): Refresh package metadata. Default ``False``.
return_dict_always (bool):
... | salt/modules/win_pkg.py | def list_available(*names, **kwargs):
'''
Return a list of available versions of the specified package.
Args:
names (str): One or more package names
Kwargs:
saltenv (str): The salt environment to use. Default ``base``.
refresh (bool): Refresh package metadata. Default ``False... | def list_available(*names, **kwargs):
'''
Return a list of available versions of the specified package.
Args:
names (str): One or more package names
Kwargs:
saltenv (str): The salt environment to use. Default ``base``.
refresh (bool): Refresh package metadata. Default ``False... | [
"Return",
"a",
"list",
"of",
"available",
"versions",
"of",
"the",
"specified",
"package",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L257-L314 | [
"def",
"list_available",
"(",
"*",
"names",
",",
"*",
"*",
"kwargs",
")",
":",
"if",
"not",
"names",
":",
"return",
"''",
"saltenv",
"=",
"kwargs",
".",
"get",
"(",
"'saltenv'",
",",
"'base'",
")",
"refresh",
"=",
"salt",
".",
"utils",
".",
"data",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | version | Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
Args:
name (str): One or more package names
Kwargs:
saltenv (str): The salt environment to use. Default ``base``.... | salt/modules/win_pkg.py | def version(*names, **kwargs):
'''
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
Args:
name (str): One or more package names
Kwargs:
saltenv (str): The... | def version(*names, **kwargs):
'''
Returns a string representing the package version or an empty string if not
installed. If more than one package name is specified, a dict of
name/version pairs is returned.
Args:
name (str): One or more package names
Kwargs:
saltenv (str): The... | [
"Returns",
"a",
"string",
"representing",
"the",
"package",
"version",
"or",
"an",
"empty",
"string",
"if",
"not",
"installed",
".",
"If",
"more",
"than",
"one",
"package",
"name",
"is",
"specified",
"a",
"dict",
"of",
"name",
"/",
"version",
"pairs",
"is"... | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L317-L364 | [
"def",
"version",
"(",
"*",
"names",
",",
"*",
"*",
"kwargs",
")",
":",
"# Standard is return empty string even if not a valid name",
"# TODO: Look at returning an error across all platforms with",
"# CommandExecutionError(msg,info={'errors': errors })",
"# available_pkgs = get_repo_data... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | list_pkgs | List the packages currently installed.
.. note::
To view installed software as displayed in the Add/Remove Programs, set
``include_components`` and ``include_updates`` to False.
Args:
versions_as_list (bool):
Returns the versions as a list
include_components (bool... | salt/modules/win_pkg.py | def list_pkgs(versions_as_list=False,
include_components=True,
include_updates=True,
**kwargs):
'''
List the packages currently installed.
.. note::
To view installed software as displayed in the Add/Remove Programs, set
``include_components`` and `... | def list_pkgs(versions_as_list=False,
include_components=True,
include_updates=True,
**kwargs):
'''
List the packages currently installed.
.. note::
To view installed software as displayed in the Add/Remove Programs, set
``include_components`` and `... | [
"List",
"the",
"packages",
"currently",
"installed",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L367-L445 | [
"def",
"list_pkgs",
"(",
"versions_as_list",
"=",
"False",
",",
"include_components",
"=",
"True",
",",
"include_updates",
"=",
"True",
",",
"*",
"*",
"kwargs",
")",
":",
"versions_as_list",
"=",
"salt",
".",
"utils",
".",
"data",
".",
"is_true",
"(",
"ver... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _get_reg_software | This searches the uninstall keys in the registry to find a match in the sub
keys, it will return a dict with the display name as the key and the
version as the value
Args:
include_components (bool):
Include sub components of installed software. Default is ``True``
include_upda... | salt/modules/win_pkg.py | def _get_reg_software(include_components=True,
include_updates=True):
'''
This searches the uninstall keys in the registry to find a match in the sub
keys, it will return a dict with the display name as the key and the
version as the value
Args:
include_components (bo... | def _get_reg_software(include_components=True,
include_updates=True):
'''
This searches the uninstall keys in the registry to find a match in the sub
keys, it will return a dict with the display name as the key and the
version as the value
Args:
include_components (bo... | [
"This",
"searches",
"the",
"uninstall",
"keys",
"in",
"the",
"registry",
"to",
"find",
"a",
"match",
"in",
"the",
"sub",
"keys",
"it",
"will",
"return",
"a",
"dict",
"with",
"the",
"display",
"name",
"as",
"the",
"key",
"and",
"the",
"version",
"as",
"... | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L448-L763 | [
"def",
"_get_reg_software",
"(",
"include_components",
"=",
"True",
",",
"include_updates",
"=",
"True",
")",
":",
"# Logic for this can be found in this question:",
"# https://social.technet.microsoft.com/Forums/windows/en-US/d913471a-d7fb-448d-869b-da9025dcc943/where-does-addremove-progr... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _refresh_db_conditional | Internal use only in this module, has a different set of defaults and
returns True or False. And supports checking the age of the existing
generated metadata db, as well as ensure metadata db exists to begin with
Args:
saltenv (str): Salt environment
Kwargs:
force (bool):
... | salt/modules/win_pkg.py | def _refresh_db_conditional(saltenv, **kwargs):
'''
Internal use only in this module, has a different set of defaults and
returns True or False. And supports checking the age of the existing
generated metadata db, as well as ensure metadata db exists to begin with
Args:
saltenv (str): Salt ... | def _refresh_db_conditional(saltenv, **kwargs):
'''
Internal use only in this module, has a different set of defaults and
returns True or False. And supports checking the age of the existing
generated metadata db, as well as ensure metadata db exists to begin with
Args:
saltenv (str): Salt ... | [
"Internal",
"use",
"only",
"in",
"this",
"module",
"has",
"a",
"different",
"set",
"of",
"defaults",
"and",
"returns",
"True",
"or",
"False",
".",
"And",
"supports",
"checking",
"the",
"age",
"of",
"the",
"existing",
"generated",
"metadata",
"db",
"as",
"w... | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L766-L832 | [
"def",
"_refresh_db_conditional",
"(",
"saltenv",
",",
"*",
"*",
"kwargs",
")",
":",
"force",
"=",
"salt",
".",
"utils",
".",
"data",
".",
"is_true",
"(",
"kwargs",
".",
"pop",
"(",
"'force'",
",",
"False",
")",
")",
"failhard",
"=",
"salt",
".",
"ut... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | refresh_db | r'''
Generates the local software metadata database (`winrepo.p`) on the minion.
The database is stored in a serialized format located by default at the
following location:
``C:\salt\var\cache\salt\minion\files\base\win\repo-ng\winrepo.p``
This module performs the following steps to generate the s... | salt/modules/win_pkg.py | def refresh_db(**kwargs):
r'''
Generates the local software metadata database (`winrepo.p`) on the minion.
The database is stored in a serialized format located by default at the
following location:
``C:\salt\var\cache\salt\minion\files\base\win\repo-ng\winrepo.p``
This module performs the fol... | def refresh_db(**kwargs):
r'''
Generates the local software metadata database (`winrepo.p`) on the minion.
The database is stored in a serialized format located by default at the
following location:
``C:\salt\var\cache\salt\minion\files\base\win\repo-ng\winrepo.p``
This module performs the fol... | [
"r",
"Generates",
"the",
"local",
"software",
"metadata",
"database",
"(",
"winrepo",
".",
"p",
")",
"on",
"the",
"minion",
".",
"The",
"database",
"is",
"stored",
"in",
"a",
"serialized",
"format",
"located",
"by",
"default",
"at",
"the",
"following",
"lo... | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L835-L961 | [
"def",
"refresh_db",
"(",
"*",
"*",
"kwargs",
")",
":",
"# Remove rtag file to keep multiple refreshes from happening in pkg states",
"salt",
".",
"utils",
".",
"pkg",
".",
"clear_rtag",
"(",
"__opts__",
")",
"saltenv",
"=",
"kwargs",
".",
"pop",
"(",
"'saltenv'",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _get_repo_details | Return repo details for the specified saltenv as a namedtuple | salt/modules/win_pkg.py | def _get_repo_details(saltenv):
'''
Return repo details for the specified saltenv as a namedtuple
'''
contextkey = 'winrepo._get_repo_details.{0}'.format(saltenv)
if contextkey in __context__:
(winrepo_source_dir, local_dest, winrepo_file) = __context__[contextkey]
else:
winrepo... | def _get_repo_details(saltenv):
'''
Return repo details for the specified saltenv as a namedtuple
'''
contextkey = 'winrepo._get_repo_details.{0}'.format(saltenv)
if contextkey in __context__:
(winrepo_source_dir, local_dest, winrepo_file) = __context__[contextkey]
else:
winrepo... | [
"Return",
"repo",
"details",
"for",
"the",
"specified",
"saltenv",
"as",
"a",
"namedtuple"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L964-L1040 | [
"def",
"_get_repo_details",
"(",
"saltenv",
")",
":",
"contextkey",
"=",
"'winrepo._get_repo_details.{0}'",
".",
"format",
"(",
"saltenv",
")",
"if",
"contextkey",
"in",
"__context__",
":",
"(",
"winrepo_source_dir",
",",
"local_dest",
",",
"winrepo_file",
")",
"=... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | genrepo | Generate package metadata db based on files within the winrepo_source_dir
Kwargs:
saltenv (str): Salt environment. Default: ``base``
verbose (bool):
Return verbose data structure which includes 'success_list', a list
of all sls files and the package names contained within.... | salt/modules/win_pkg.py | def genrepo(**kwargs):
'''
Generate package metadata db based on files within the winrepo_source_dir
Kwargs:
saltenv (str): Salt environment. Default: ``base``
verbose (bool):
Return verbose data structure which includes 'success_list', a list
of all sls files and ... | def genrepo(**kwargs):
'''
Generate package metadata db based on files within the winrepo_source_dir
Kwargs:
saltenv (str): Salt environment. Default: ``base``
verbose (bool):
Return verbose data structure which includes 'success_list', a list
of all sls files and ... | [
"Generate",
"package",
"metadata",
"db",
"based",
"on",
"files",
"within",
"the",
"winrepo_source_dir"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L1043-L1143 | [
"def",
"genrepo",
"(",
"*",
"*",
"kwargs",
")",
":",
"saltenv",
"=",
"kwargs",
".",
"pop",
"(",
"'saltenv'",
",",
"'base'",
")",
"verbose",
"=",
"salt",
".",
"utils",
".",
"data",
".",
"is_true",
"(",
"kwargs",
".",
"pop",
"(",
"'verbose'",
",",
"F... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _get_source_sum | Extract the hash sum, whether it is in a remote hash file, or just a string. | salt/modules/win_pkg.py | def _get_source_sum(source_hash, file_path, saltenv):
'''
Extract the hash sum, whether it is in a remote hash file, or just a string.
'''
ret = dict()
schemes = ('salt', 'http', 'https', 'ftp', 'swift', 's3', 'file')
invalid_hash_msg = ("Source hash '{0}' format is invalid. It must be in "
... | def _get_source_sum(source_hash, file_path, saltenv):
'''
Extract the hash sum, whether it is in a remote hash file, or just a string.
'''
ret = dict()
schemes = ('salt', 'http', 'https', 'ftp', 'swift', 's3', 'file')
invalid_hash_msg = ("Source hash '{0}' format is invalid. It must be in "
... | [
"Extract",
"the",
"hash",
"sum",
"whether",
"it",
"is",
"in",
"a",
"remote",
"hash",
"file",
"or",
"just",
"a",
"string",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L1218-L1252 | [
"def",
"_get_source_sum",
"(",
"source_hash",
",",
"file_path",
",",
"saltenv",
")",
":",
"ret",
"=",
"dict",
"(",
")",
"schemes",
"=",
"(",
"'salt'",
",",
"'http'",
",",
"'https'",
",",
"'ftp'",
",",
"'swift'",
",",
"'s3'",
",",
"'file'",
")",
"invali... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _get_msiexec | Return if msiexec.exe will be used and the command to invoke it. | salt/modules/win_pkg.py | def _get_msiexec(use_msiexec):
'''
Return if msiexec.exe will be used and the command to invoke it.
'''
if use_msiexec is False:
return False, ''
if isinstance(use_msiexec, six.string_types):
if os.path.isfile(use_msiexec):
return True, use_msiexec
else:
... | def _get_msiexec(use_msiexec):
'''
Return if msiexec.exe will be used and the command to invoke it.
'''
if use_msiexec is False:
return False, ''
if isinstance(use_msiexec, six.string_types):
if os.path.isfile(use_msiexec):
return True, use_msiexec
else:
... | [
"Return",
"if",
"msiexec",
".",
"exe",
"will",
"be",
"used",
"and",
"the",
"command",
"to",
"invoke",
"it",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L1255-L1271 | [
"def",
"_get_msiexec",
"(",
"use_msiexec",
")",
":",
"if",
"use_msiexec",
"is",
"False",
":",
"return",
"False",
",",
"''",
"if",
"isinstance",
"(",
"use_msiexec",
",",
"six",
".",
"string_types",
")",
":",
"if",
"os",
".",
"path",
".",
"isfile",
"(",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | install | r'''
Install the passed package(s) on the system using winrepo
Args:
name (str):
The name of a single package, or a comma-separated list of packages
to install. (no spaces after the commas)
refresh (bool):
Boolean value representing whether or not to refres... | salt/modules/win_pkg.py | def install(name=None, refresh=False, pkgs=None, **kwargs):
r'''
Install the passed package(s) on the system using winrepo
Args:
name (str):
The name of a single package, or a comma-separated list of packages
to install. (no spaces after the commas)
refresh (bool):... | def install(name=None, refresh=False, pkgs=None, **kwargs):
r'''
Install the passed package(s) on the system using winrepo
Args:
name (str):
The name of a single package, or a comma-separated list of packages
to install. (no spaces after the commas)
refresh (bool):... | [
"r",
"Install",
"the",
"passed",
"package",
"(",
"s",
")",
"on",
"the",
"system",
"using",
"winrepo"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L1274-L1723 | [
"def",
"install",
"(",
"name",
"=",
"None",
",",
"refresh",
"=",
"False",
",",
"pkgs",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"ret",
"=",
"{",
"}",
"saltenv",
"=",
"kwargs",
".",
"pop",
"(",
"'saltenv'",
",",
"'base'",
")",
"refresh",
"=... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | upgrade | Upgrade all software. Currently not implemented
Kwargs:
saltenv (str): The salt environment to use. Default ``base``.
refresh (bool): Refresh package metadata. Default ``True``.
.. note::
This feature is not yet implemented for Windows.
Returns:
dict: Empty dict, until imp... | salt/modules/win_pkg.py | def upgrade(**kwargs):
'''
Upgrade all software. Currently not implemented
Kwargs:
saltenv (str): The salt environment to use. Default ``base``.
refresh (bool): Refresh package metadata. Default ``True``.
.. note::
This feature is not yet implemented for Windows.
Returns:
... | def upgrade(**kwargs):
'''
Upgrade all software. Currently not implemented
Kwargs:
saltenv (str): The salt environment to use. Default ``base``.
refresh (bool): Refresh package metadata. Default ``True``.
.. note::
This feature is not yet implemented for Windows.
Returns:
... | [
"Upgrade",
"all",
"software",
".",
"Currently",
"not",
"implemented"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L1726-L1754 | [
"def",
"upgrade",
"(",
"*",
"*",
"kwargs",
")",
":",
"log",
".",
"warning",
"(",
"'pkg.upgrade not implemented on Windows yet'",
")",
"refresh",
"=",
"salt",
".",
"utils",
".",
"data",
".",
"is_true",
"(",
"kwargs",
".",
"get",
"(",
"'refresh'",
",",
"True... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | remove | Remove the passed package(s) from the system using winrepo
.. versionadded:: 0.16.0
Args:
name (str):
The name(s) of the package(s) to be uninstalled. Can be a
single package or a comma delimited list of packages, no spaces.
pkgs (list):
A list of packages ... | salt/modules/win_pkg.py | def remove(name=None, pkgs=None, **kwargs):
'''
Remove the passed package(s) from the system using winrepo
.. versionadded:: 0.16.0
Args:
name (str):
The name(s) of the package(s) to be uninstalled. Can be a
single package or a comma delimited list of packages, no space... | def remove(name=None, pkgs=None, **kwargs):
'''
Remove the passed package(s) from the system using winrepo
.. versionadded:: 0.16.0
Args:
name (str):
The name(s) of the package(s) to be uninstalled. Can be a
single package or a comma delimited list of packages, no space... | [
"Remove",
"the",
"passed",
"package",
"(",
"s",
")",
"from",
"the",
"system",
"using",
"winrepo"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L1757-L2044 | [
"def",
"remove",
"(",
"name",
"=",
"None",
",",
"pkgs",
"=",
"None",
",",
"*",
"*",
"kwargs",
")",
":",
"saltenv",
"=",
"kwargs",
".",
"get",
"(",
"'saltenv'",
",",
"'base'",
")",
"refresh",
"=",
"salt",
".",
"utils",
".",
"data",
".",
"is_true",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | get_repo_data | Returns the existing package metadata db. Will create it, if it does not
exist, however will not refresh it.
Args:
saltenv (str): Salt environment. Default ``base``
Returns:
dict: A dict containing contents of metadata db.
CLI Example:
.. code-block:: bash
salt '*' pkg.g... | salt/modules/win_pkg.py | def get_repo_data(saltenv='base'):
'''
Returns the existing package metadata db. Will create it, if it does not
exist, however will not refresh it.
Args:
saltenv (str): Salt environment. Default ``base``
Returns:
dict: A dict containing contents of metadata db.
CLI Example:
... | def get_repo_data(saltenv='base'):
'''
Returns the existing package metadata db. Will create it, if it does not
exist, however will not refresh it.
Args:
saltenv (str): Salt environment. Default ``base``
Returns:
dict: A dict containing contents of metadata db.
CLI Example:
... | [
"Returns",
"the",
"existing",
"package",
"metadata",
"db",
".",
"Will",
"create",
"it",
"if",
"it",
"does",
"not",
"exist",
"however",
"will",
"not",
"refresh",
"it",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L2088-L2134 | [
"def",
"get_repo_data",
"(",
"saltenv",
"=",
"'base'",
")",
":",
"# we only call refresh_db if it does not exist, as we want to return",
"# the existing data even if its old, other parts of the code call this,",
"# but they will call refresh if they need too.",
"repo_details",
"=",
"_get_r... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _get_name_map | Return a reverse map of full pkg names to the names recognized by winrepo. | salt/modules/win_pkg.py | def _get_name_map(saltenv='base'):
'''
Return a reverse map of full pkg names to the names recognized by winrepo.
'''
u_name_map = {}
name_map = get_repo_data(saltenv).get('name_map', {})
if not six.PY2:
return name_map
for k in name_map:
u_name_map[k] = name_map[k]
ret... | def _get_name_map(saltenv='base'):
'''
Return a reverse map of full pkg names to the names recognized by winrepo.
'''
u_name_map = {}
name_map = get_repo_data(saltenv).get('name_map', {})
if not six.PY2:
return name_map
for k in name_map:
u_name_map[k] = name_map[k]
ret... | [
"Return",
"a",
"reverse",
"map",
"of",
"full",
"pkg",
"names",
"to",
"the",
"names",
"recognized",
"by",
"winrepo",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L2137-L2149 | [
"def",
"_get_name_map",
"(",
"saltenv",
"=",
"'base'",
")",
":",
"u_name_map",
"=",
"{",
"}",
"name_map",
"=",
"get_repo_data",
"(",
"saltenv",
")",
".",
"get",
"(",
"'name_map'",
",",
"{",
"}",
")",
"if",
"not",
"six",
".",
"PY2",
":",
"return",
"na... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | compare_versions | Compare software package versions
Args:
ver1 (str): A software version to compare
oper (str): The operand to use to compare
ver2 (str): A software version to compare
Returns:
bool: True if the comparison is valid, otherwise False
CLI Example:
.. code-block:: bash
... | salt/modules/win_pkg.py | def compare_versions(ver1='', oper='==', ver2=''):
'''
Compare software package versions
Args:
ver1 (str): A software version to compare
oper (str): The operand to use to compare
ver2 (str): A software version to compare
Returns:
bool: True if the comparison is valid, o... | def compare_versions(ver1='', oper='==', ver2=''):
'''
Compare software package versions
Args:
ver1 (str): A software version to compare
oper (str): The operand to use to compare
ver2 (str): A software version to compare
Returns:
bool: True if the comparison is valid, o... | [
"Compare",
"software",
"package",
"versions"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_pkg.py#L2184-L2218 | [
"def",
"compare_versions",
"(",
"ver1",
"=",
"''",
",",
"oper",
"=",
"'=='",
",",
"ver2",
"=",
"''",
")",
":",
"if",
"not",
"ver1",
":",
"raise",
"SaltInvocationError",
"(",
"'compare_version, ver1 is blank'",
")",
"if",
"not",
"ver2",
":",
"raise",
"SaltI... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | GitConfigParser._read | Makes the following changes from the RawConfigParser:
1. Strip leading tabs from non-section-header lines.
2. Treat 8 spaces at the beginning of a line as a tab.
3. Treat lines beginning with a tab as options.
4. Drops support for continuation lines.
5. Multiple values for a giv... | salt/utils/configparser.py | def _read(self, fp, fpname):
'''
Makes the following changes from the RawConfigParser:
1. Strip leading tabs from non-section-header lines.
2. Treat 8 spaces at the beginning of a line as a tab.
3. Treat lines beginning with a tab as options.
4. Drops support for continu... | def _read(self, fp, fpname):
'''
Makes the following changes from the RawConfigParser:
1. Strip leading tabs from non-section-header lines.
2. Treat 8 spaces at the beginning of a line as a tab.
3. Treat lines beginning with a tab as options.
4. Drops support for continu... | [
"Makes",
"the",
"following",
"changes",
"from",
"the",
"RawConfigParser",
":"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/configparser.py#L57-L137 | [
"def",
"_read",
"(",
"self",
",",
"fp",
",",
"fpname",
")",
":",
"cursect",
"=",
"None",
"# None, or a dictionary",
"optname",
"=",
"None",
"lineno",
"=",
"0",
"e",
"=",
"None",
"# None, or an exception",
"while",
"True",
":",
"line",
"=",
"salt",
".",
"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | GitConfigParser._string_check | Based on the string-checking code from the SafeConfigParser's set()
function, this enforces string values for config options. | salt/utils/configparser.py | def _string_check(self, value, allow_list=False):
'''
Based on the string-checking code from the SafeConfigParser's set()
function, this enforces string values for config options.
'''
if self._optcre is self.OPTCRE or value:
is_list = isinstance(value, list)
... | def _string_check(self, value, allow_list=False):
'''
Based on the string-checking code from the SafeConfigParser's set()
function, this enforces string values for config options.
'''
if self._optcre is self.OPTCRE or value:
is_list = isinstance(value, list)
... | [
"Based",
"on",
"the",
"string",
"-",
"checking",
"code",
"from",
"the",
"SafeConfigParser",
"s",
"set",
"()",
"function",
"this",
"enforces",
"string",
"values",
"for",
"config",
"options",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/configparser.py#L139-L151 | [
"def",
"_string_check",
"(",
"self",
",",
"value",
",",
"allow_list",
"=",
"False",
")",
":",
"if",
"self",
".",
"_optcre",
"is",
"self",
".",
"OPTCRE",
"or",
"value",
":",
"is_list",
"=",
"isinstance",
"(",
"value",
",",
"list",
")",
"if",
"is_list",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | GitConfigParser.get | Adds an optional "as_list" argument to ensure a list is returned. This
is helpful when iterating over an option which may or may not be a
multivar. | salt/utils/configparser.py | def get(self, section, option, as_list=False):
'''
Adds an optional "as_list" argument to ensure a list is returned. This
is helpful when iterating over an option which may or may not be a
multivar.
'''
ret = super(GitConfigParser, self).get(section, option)
if as... | def get(self, section, option, as_list=False):
'''
Adds an optional "as_list" argument to ensure a list is returned. This
is helpful when iterating over an option which may or may not be a
multivar.
'''
ret = super(GitConfigParser, self).get(section, option)
if as... | [
"Adds",
"an",
"optional",
"as_list",
"argument",
"to",
"ensure",
"a",
"list",
"is",
"returned",
".",
"This",
"is",
"helpful",
"when",
"iterating",
"over",
"an",
"option",
"which",
"may",
"or",
"may",
"not",
"be",
"a",
"multivar",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/configparser.py#L153-L162 | [
"def",
"get",
"(",
"self",
",",
"section",
",",
"option",
",",
"as_list",
"=",
"False",
")",
":",
"ret",
"=",
"super",
"(",
"GitConfigParser",
",",
"self",
")",
".",
"get",
"(",
"section",
",",
"option",
")",
"if",
"as_list",
"and",
"not",
"isinstanc... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | GitConfigParser.set | This is overridden from the RawConfigParser merely to change the
default value for the 'value' argument. | salt/utils/configparser.py | def set(self, section, option, value=''):
'''
This is overridden from the RawConfigParser merely to change the
default value for the 'value' argument.
'''
self._string_check(value)
super(GitConfigParser, self).set(section, option, value) | def set(self, section, option, value=''):
'''
This is overridden from the RawConfigParser merely to change the
default value for the 'value' argument.
'''
self._string_check(value)
super(GitConfigParser, self).set(section, option, value) | [
"This",
"is",
"overridden",
"from",
"the",
"RawConfigParser",
"merely",
"to",
"change",
"the",
"default",
"value",
"for",
"the",
"value",
"argument",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/configparser.py#L164-L170 | [
"def",
"set",
"(",
"self",
",",
"section",
",",
"option",
",",
"value",
"=",
"''",
")",
":",
"self",
".",
"_string_check",
"(",
"value",
")",
"super",
"(",
"GitConfigParser",
",",
"self",
")",
".",
"set",
"(",
"section",
",",
"option",
",",
"value",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | GitConfigParser.set_multivar | This function is unique to the GitConfigParser. It will add another
value for the option if it already exists, converting the option's
value to a list if applicable.
If "value" is a list, then any existing values for the specified
section and option will be replaced with the list being ... | salt/utils/configparser.py | def set_multivar(self, section, option, value=''):
'''
This function is unique to the GitConfigParser. It will add another
value for the option if it already exists, converting the option's
value to a list if applicable.
If "value" is a list, then any existing values for the spe... | def set_multivar(self, section, option, value=''):
'''
This function is unique to the GitConfigParser. It will add another
value for the option if it already exists, converting the option's
value to a list if applicable.
If "value" is a list, then any existing values for the spe... | [
"This",
"function",
"is",
"unique",
"to",
"the",
"GitConfigParser",
".",
"It",
"will",
"add",
"another",
"value",
"for",
"the",
"option",
"if",
"it",
"already",
"exists",
"converting",
"the",
"option",
"s",
"value",
"to",
"a",
"list",
"if",
"applicable",
"... | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/configparser.py#L189-L208 | [
"def",
"set_multivar",
"(",
"self",
",",
"section",
",",
"option",
",",
"value",
"=",
"''",
")",
":",
"self",
".",
"_string_check",
"(",
"value",
",",
"allow_list",
"=",
"True",
")",
"if",
"not",
"section",
"or",
"section",
"==",
"self",
".",
"DEFAULTS... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | GitConfigParser.remove_option_regexp | Remove an option with a value matching the expression. Works on single
values and multivars. | salt/utils/configparser.py | def remove_option_regexp(self, section, option, expr):
'''
Remove an option with a value matching the expression. Works on single
values and multivars.
'''
if not section or section == self.DEFAULTSECT:
sectdict = self._defaults
else:
try:
... | def remove_option_regexp(self, section, option, expr):
'''
Remove an option with a value matching the expression. Works on single
values and multivars.
'''
if not section or section == self.DEFAULTSECT:
sectdict = self._defaults
else:
try:
... | [
"Remove",
"an",
"option",
"with",
"a",
"value",
"matching",
"the",
"expression",
".",
"Works",
"on",
"single",
"values",
"and",
"multivars",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/configparser.py#L210-L241 | [
"def",
"remove_option_regexp",
"(",
"self",
",",
"section",
",",
"option",
",",
"expr",
")",
":",
"if",
"not",
"section",
"or",
"section",
"==",
"self",
".",
"DEFAULTSECT",
":",
"sectdict",
"=",
"self",
".",
"_defaults",
"else",
":",
"try",
":",
"sectdic... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | GitConfigParser.write | Makes the following changes from the RawConfigParser:
1. Prepends options with a tab character.
2. Does not write a blank line between sections.
3. When an option's value is a list, a line for each option is written.
This allows us to support multivars like a remote's "fetch" option.... | salt/utils/configparser.py | def write(self, fp_):
'''
Makes the following changes from the RawConfigParser:
1. Prepends options with a tab character.
2. Does not write a blank line between sections.
3. When an option's value is a list, a line for each option is written.
This allows us to support... | def write(self, fp_):
'''
Makes the following changes from the RawConfigParser:
1. Prepends options with a tab character.
2. Does not write a blank line between sections.
3. When an option's value is a list, a line for each option is written.
This allows us to support... | [
"Makes",
"the",
"following",
"changes",
"from",
"the",
"RawConfigParser",
":"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/configparser.py#L243-L268 | [
"def",
"write",
"(",
"self",
",",
"fp_",
")",
":",
"convert",
"=",
"salt",
".",
"utils",
".",
"stringutils",
".",
"to_bytes",
"if",
"'b'",
"in",
"fp_",
".",
"mode",
"else",
"salt",
".",
"utils",
".",
"stringutils",
".",
"to_str",
"if",
"self",
".",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | ext_pillar | Read a CSV into Pillar
:param str path: Absolute path to a CSV file.
:param str idkey: (Optional) The column name of minion IDs.
:param str namespace: (Optional) A pillar key to namespace the values under.
:param list fieldnames: (Optional) if the first row of the CSV is not
column names they m... | salt/pillar/csvpillar.py | def ext_pillar(
mid,
pillar,
path,
idkey='id',
namespace=None,
fieldnames=None,
restkey=None,
restval=None,
dialect='excel'):
'''
Read a CSV into Pillar
:param str path: Absolute path to a CSV file.
:param str idkey: (Optional) The... | def ext_pillar(
mid,
pillar,
path,
idkey='id',
namespace=None,
fieldnames=None,
restkey=None,
restval=None,
dialect='excel'):
'''
Read a CSV into Pillar
:param str path: Absolute path to a CSV file.
:param str idkey: (Optional) The... | [
"Read",
"a",
"CSV",
"into",
"Pillar"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/pillar/csvpillar.py#L60-L90 | [
"def",
"ext_pillar",
"(",
"mid",
",",
"pillar",
",",
"path",
",",
"idkey",
"=",
"'id'",
",",
"namespace",
"=",
"None",
",",
"fieldnames",
"=",
"None",
",",
"restkey",
"=",
"None",
",",
"restval",
"=",
"None",
",",
"dialect",
"=",
"'excel'",
")",
":",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | set_ | Set a value in an OpenStack configuration file.
filename
The full path to the configuration file
section
The section in which the parameter will be set
parameter
The parameter to change
value
The value to set
CLI Example:
.. code-block:: bash
salt-c... | salt/modules/openstack_config.py | def set_(filename, section, parameter, value):
'''
Set a value in an OpenStack configuration file.
filename
The full path to the configuration file
section
The section in which the parameter will be set
parameter
The parameter to change
value
The value to set
... | def set_(filename, section, parameter, value):
'''
Set a value in an OpenStack configuration file.
filename
The full path to the configuration file
section
The section in which the parameter will be set
parameter
The parameter to change
value
The value to set
... | [
"Set",
"a",
"value",
"in",
"an",
"OpenStack",
"configuration",
"file",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/openstack_config.py#L50-L88 | [
"def",
"set_",
"(",
"filename",
",",
"section",
",",
"parameter",
",",
"value",
")",
":",
"filename",
"=",
"_quote",
"(",
"filename",
")",
"section",
"=",
"_quote",
"(",
"section",
")",
"parameter",
"=",
"_quote",
"(",
"parameter",
")",
"value",
"=",
"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | get | Get a value from an OpenStack configuration file.
filename
The full path to the configuration file
section
The section from which to search for the parameter
parameter
The parameter to return
CLI Example:
.. code-block:: bash
salt-call openstack_config.get /etc/... | salt/modules/openstack_config.py | def get(filename, section, parameter):
'''
Get a value from an OpenStack configuration file.
filename
The full path to the configuration file
section
The section from which to search for the parameter
parameter
The parameter to return
CLI Example:
.. code-block::... | def get(filename, section, parameter):
'''
Get a value from an OpenStack configuration file.
filename
The full path to the configuration file
section
The section from which to search for the parameter
parameter
The parameter to return
CLI Example:
.. code-block::... | [
"Get",
"a",
"value",
"from",
"an",
"OpenStack",
"configuration",
"file",
"."
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/openstack_config.py#L92-L127 | [
"def",
"get",
"(",
"filename",
",",
"section",
",",
"parameter",
")",
":",
"filename",
"=",
"_quote",
"(",
"filename",
")",
"section",
"=",
"_quote",
"(",
"section",
")",
"parameter",
"=",
"_quote",
"(",
"parameter",
")",
"result",
"=",
"__salt__",
"[",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | present | Ensure an ACE is present | salt/states/win_dacl.py | def present(name, objectType, user, permission, acetype, propagation):
'''
Ensure an ACE is present
'''
ret = {'name': name,
'result': True,
'changes': {},
'comment': ''}
tRet = __salt__['win_dacl.check_ace'](name, objectType, user, permission, acetype, propagation, ... | def present(name, objectType, user, permission, acetype, propagation):
'''
Ensure an ACE is present
'''
ret = {'name': name,
'result': True,
'changes': {},
'comment': ''}
tRet = __salt__['win_dacl.check_ace'](name, objectType, user, permission, acetype, propagation, ... | [
"Ensure",
"an",
"ACE",
"is",
"present"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/win_dacl.py#L86-L118 | [
"def",
"present",
"(",
"name",
",",
"objectType",
",",
"user",
",",
"permission",
",",
"acetype",
",",
"propagation",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'result'",
":",
"True",
",",
"'changes'",
":",
"{",
"}",
",",
"'comment'",
"... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | inherit | Ensure an object is inheriting ACLs from its parent | salt/states/win_dacl.py | def inherit(name, objectType, clear_existing_acl=False):
'''
Ensure an object is inheriting ACLs from its parent
'''
ret = {'name': name,
'result': True,
'changes': {},
'comment': ''}
tRet = __salt__['win_dacl.check_inheritance'](name, objectType)
if tRet['result... | def inherit(name, objectType, clear_existing_acl=False):
'''
Ensure an object is inheriting ACLs from its parent
'''
ret = {'name': name,
'result': True,
'changes': {},
'comment': ''}
tRet = __salt__['win_dacl.check_inheritance'](name, objectType)
if tRet['result... | [
"Ensure",
"an",
"object",
"is",
"inheriting",
"ACLs",
"from",
"its",
"parent"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/win_dacl.py#L156-L188 | [
"def",
"inherit",
"(",
"name",
",",
"objectType",
",",
"clear_existing_acl",
"=",
"False",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'result'",
":",
"True",
",",
"'changes'",
":",
"{",
"}",
",",
"'comment'",
":",
"''",
"}",
"tRet",
"=",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | disinherit | Ensure an object is not inheriting ACLs from its parent | salt/states/win_dacl.py | def disinherit(name, objectType, copy_inherited_acl=True):
'''
Ensure an object is not inheriting ACLs from its parent
'''
ret = {'name': name,
'result': True,
'changes': {},
'comment': ''}
tRet = __salt__['win_dacl.check_inheritance'](name, objectType)
if tRet['... | def disinherit(name, objectType, copy_inherited_acl=True):
'''
Ensure an object is not inheriting ACLs from its parent
'''
ret = {'name': name,
'result': True,
'changes': {},
'comment': ''}
tRet = __salt__['win_dacl.check_inheritance'](name, objectType)
if tRet['... | [
"Ensure",
"an",
"object",
"is",
"not",
"inheriting",
"ACLs",
"from",
"its",
"parent"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/win_dacl.py#L191-L222 | [
"def",
"disinherit",
"(",
"name",
",",
"objectType",
",",
"copy_inherited_acl",
"=",
"True",
")",
":",
"ret",
"=",
"{",
"'name'",
":",
"name",
",",
"'result'",
":",
"True",
",",
"'changes'",
":",
"{",
"}",
",",
"'comment'",
":",
"''",
"}",
"tRet",
"=... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | output | Update the progress bar | salt/output/progress.py | def output(ret, bar, **kwargs): # pylint: disable=unused-argument
'''
Update the progress bar
'''
if 'return_count' in ret:
val = ret['return_count']
# Avoid to fail if targets are behind a syndic. In this case actual return count will be
# higher than targeted by MoM itself.
... | def output(ret, bar, **kwargs): # pylint: disable=unused-argument
'''
Update the progress bar
'''
if 'return_count' in ret:
val = ret['return_count']
# Avoid to fail if targets are behind a syndic. In this case actual return count will be
# higher than targeted by MoM itself.
... | [
"Update",
"the",
"progress",
"bar"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/output/progress.py#L21-L34 | [
"def",
"output",
"(",
"ret",
",",
"bar",
",",
"*",
"*",
"kwargs",
")",
":",
"# pylint: disable=unused-argument",
"if",
"'return_count'",
"in",
"ret",
":",
"val",
"=",
"ret",
"[",
"'return_count'",
"]",
"# Avoid to fail if targets are behind a syndic. In this case actu... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | progress_iter | Initialize and return a progress bar iter | salt/output/progress.py | def progress_iter(progress):
'''
Initialize and return a progress bar iter
'''
widgets = [progressbar.Percentage(), ' ', progressbar.Bar(), ' ', progressbar.Timer(), ' Returns: [', progressbar.Counter(), '/{0}]'.format(progress['minion_count'])]
bar = progressbar.ProgressBar(widgets=widgets, maxval=... | def progress_iter(progress):
'''
Initialize and return a progress bar iter
'''
widgets = [progressbar.Percentage(), ' ', progressbar.Bar(), ' ', progressbar.Timer(), ' Returns: [', progressbar.Counter(), '/{0}]'.format(progress['minion_count'])]
bar = progressbar.ProgressBar(widgets=widgets, maxval=... | [
"Initialize",
"and",
"return",
"a",
"progress",
"bar",
"iter"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/output/progress.py#L37-L44 | [
"def",
"progress_iter",
"(",
"progress",
")",
":",
"widgets",
"=",
"[",
"progressbar",
".",
"Percentage",
"(",
")",
",",
"' '",
",",
"progressbar",
".",
"Bar",
"(",
")",
",",
"' '",
",",
"progressbar",
".",
"Timer",
"(",
")",
",",
"' Returns: ['",
",",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | mksls | Convert a preseed file to an SLS file | salt/utils/preseed.py | def mksls(src, dst=None):
'''
Convert a preseed file to an SLS file
'''
ps_opts = {}
with salt.utils.files.fopen(src, 'r') as fh_:
for line in fh_:
line = salt.utils.stringutils.to_unicode(line)
if line.startswith('#'):
continue
if not line... | def mksls(src, dst=None):
'''
Convert a preseed file to an SLS file
'''
ps_opts = {}
with salt.utils.files.fopen(src, 'r') as fh_:
for line in fh_:
line = salt.utils.stringutils.to_unicode(line)
if line.startswith('#'):
continue
if not line... | [
"Convert",
"a",
"preseed",
"file",
"to",
"an",
"SLS",
"file"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/preseed.py#L14-L80 | [
"def",
"mksls",
"(",
"src",
",",
"dst",
"=",
"None",
")",
":",
"ps_opts",
"=",
"{",
"}",
"with",
"salt",
".",
"utils",
".",
"files",
".",
"fopen",
"(",
"src",
",",
"'r'",
")",
"as",
"fh_",
":",
"for",
"line",
"in",
"fh_",
":",
"line",
"=",
"s... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _updateNamespace | helper function to recursively update the namespaces of an item | salt/modules/win_lgpo.py | def _updateNamespace(item, new_namespace):
'''
helper function to recursively update the namespaces of an item
'''
temp_item = ''
i = item.tag.find('}')
if i >= 0:
temp_item = item.tag[i+1:]
else:
temp_item = item.tag
item.tag = '{{{0}}}{1}'.format(new_namespace, temp_ite... | def _updateNamespace(item, new_namespace):
'''
helper function to recursively update the namespaces of an item
'''
temp_item = ''
i = item.tag.find('}')
if i >= 0:
temp_item = item.tag[i+1:]
else:
temp_item = item.tag
item.tag = '{{{0}}}{1}'.format(new_namespace, temp_ite... | [
"helper",
"function",
"to",
"recursively",
"update",
"the",
"namespaces",
"of",
"an",
"item"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_lgpo.py#L4750-L4770 | [
"def",
"_updateNamespace",
"(",
"item",
",",
"new_namespace",
")",
":",
"temp_item",
"=",
"''",
"i",
"=",
"item",
".",
"tag",
".",
"find",
"(",
"'}'",
")",
"if",
"i",
">=",
"0",
":",
"temp_item",
"=",
"item",
".",
"tag",
"[",
"i",
"+",
"1",
":",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _updatePolicyElements | helper function to add the reg key to each policies element definitions if
the key attribute is not defined to make xpath searching easier for each
child in the policy <elements> item | salt/modules/win_lgpo.py | def _updatePolicyElements(policy_item, regkey):
'''
helper function to add the reg key to each policies element definitions if
the key attribute is not defined to make xpath searching easier for each
child in the policy <elements> item
'''
for child in policy_item.getiterator():
if 'valu... | def _updatePolicyElements(policy_item, regkey):
'''
helper function to add the reg key to each policies element definitions if
the key attribute is not defined to make xpath searching easier for each
child in the policy <elements> item
'''
for child in policy_item.getiterator():
if 'valu... | [
"helper",
"function",
"to",
"add",
"the",
"reg",
"key",
"to",
"each",
"policies",
"element",
"definitions",
"if",
"the",
"key",
"attribute",
"is",
"not",
"defined",
"to",
"make",
"xpath",
"searching",
"easier",
"for",
"each",
"child",
"in",
"the",
"policy",
... | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_lgpo.py#L4773-L4783 | [
"def",
"_updatePolicyElements",
"(",
"policy_item",
",",
"regkey",
")",
":",
"for",
"child",
"in",
"policy_item",
".",
"getiterator",
"(",
")",
":",
"if",
"'valueName'",
"in",
"child",
".",
"attrib",
":",
"if",
"'key'",
"not",
"in",
"child",
".",
"attrib",... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _remove_unicode_encoding | attempts to remove the "encoding='unicode'" from an xml file
as lxml does not support that on a windows node currently
see issue #38100 | salt/modules/win_lgpo.py | def _remove_unicode_encoding(xml_file):
'''
attempts to remove the "encoding='unicode'" from an xml file
as lxml does not support that on a windows node currently
see issue #38100
'''
with salt.utils.files.fopen(xml_file, 'rb') as f:
xml_content = f.read()
modified_xml = re.sub(r' en... | def _remove_unicode_encoding(xml_file):
'''
attempts to remove the "encoding='unicode'" from an xml file
as lxml does not support that on a windows node currently
see issue #38100
'''
with salt.utils.files.fopen(xml_file, 'rb') as f:
xml_content = f.read()
modified_xml = re.sub(r' en... | [
"attempts",
"to",
"remove",
"the",
"encoding",
"=",
"unicode",
"from",
"an",
"xml",
"file",
"as",
"lxml",
"does",
"not",
"support",
"that",
"on",
"a",
"windows",
"node",
"currently",
"see",
"issue",
"#38100"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_lgpo.py#L4786-L4796 | [
"def",
"_remove_unicode_encoding",
"(",
"xml_file",
")",
":",
"with",
"salt",
".",
"utils",
".",
"files",
".",
"fopen",
"(",
"xml_file",
",",
"'rb'",
")",
"as",
"f",
":",
"xml_content",
"=",
"f",
".",
"read",
"(",
")",
"modified_xml",
"=",
"re",
".",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _load_policy_definitions | helper function to process all ADMX files in the specified policy_def_path
and build a single XML doc that we can search/use for ADMX policy processing | salt/modules/win_lgpo.py | def _load_policy_definitions(path='c:\\Windows\\PolicyDefinitions',
language='en-US'):
'''
helper function to process all ADMX files in the specified policy_def_path
and build a single XML doc that we can search/use for ADMX policy processing
'''
# Fallback to the System... | def _load_policy_definitions(path='c:\\Windows\\PolicyDefinitions',
language='en-US'):
'''
helper function to process all ADMX files in the specified policy_def_path
and build a single XML doc that we can search/use for ADMX policy processing
'''
# Fallback to the System... | [
"helper",
"function",
"to",
"process",
"all",
"ADMX",
"files",
"in",
"the",
"specified",
"policy_def_path",
"and",
"build",
"a",
"single",
"XML",
"doc",
"that",
"we",
"can",
"search",
"/",
"use",
"for",
"ADMX",
"policy",
"processing"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_lgpo.py#L4799-L4944 | [
"def",
"_load_policy_definitions",
"(",
"path",
"=",
"'c:\\\\Windows\\\\PolicyDefinitions'",
",",
"language",
"=",
"'en-US'",
")",
":",
"# Fallback to the System Install Language",
"display_language_fallback",
"=",
"INSTALL_LANGUAGE",
"t_policy_definitions",
"=",
"lxml",
".",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
train | _buildElementNsmap | build a namespace map for an ADMX element | salt/modules/win_lgpo.py | def _buildElementNsmap(using_elements):
'''
build a namespace map for an ADMX element
'''
thisMap = {}
for e in using_elements:
thisMap[e.attrib['prefix']] = e.attrib['namespace']
return thisMap | def _buildElementNsmap(using_elements):
'''
build a namespace map for an ADMX element
'''
thisMap = {}
for e in using_elements:
thisMap[e.attrib['prefix']] = e.attrib['namespace']
return thisMap | [
"build",
"a",
"namespace",
"map",
"for",
"an",
"ADMX",
"element"
] | saltstack/salt | python | https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_lgpo.py#L4963-L4970 | [
"def",
"_buildElementNsmap",
"(",
"using_elements",
")",
":",
"thisMap",
"=",
"{",
"}",
"for",
"e",
"in",
"using_elements",
":",
"thisMap",
"[",
"e",
".",
"attrib",
"[",
"'prefix'",
"]",
"]",
"=",
"e",
".",
"attrib",
"[",
"'namespace'",
"]",
"return",
... | e8541fd6e744ab0df786c0f76102e41631f45d46 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.