repo
stringclasses
85 values
path
stringlengths
8
121
func_name
stringlengths
1
82
original_string
stringlengths
112
65.5k
language
stringclasses
1 value
code
stringlengths
112
65.5k
code_tokens
listlengths
20
4.09k
docstring
stringlengths
3
46.3k
docstring_tokens
listlengths
1
564
sha
stringclasses
85 values
url
stringlengths
93
218
partition
stringclasses
1 value
saltstack/salt
salt/states/lxd_profile.py
present
def present(name, description=None, config=None, devices=None, remote_addr=None, cert=None, key=None, verify_cert=True): ''' Creates or updates LXD profiles name : The name of the profile to create/update description : A description string config : A config dic...
python
def present(name, description=None, config=None, devices=None, remote_addr=None, cert=None, key=None, verify_cert=True): ''' Creates or updates LXD profiles name : The name of the profile to create/update description : A description string config : A config dic...
[ "def", "present", "(", "name", ",", "description", "=", "None", ",", "config", "=", "None", ",", "devices", "=", "None", ",", "remote_addr", "=", "None", ",", "cert", "=", "None", ",", "key", "=", "None", ",", "verify_cert", "=", "True", ")", ":", ...
Creates or updates LXD profiles name : The name of the profile to create/update description : A description string config : A config dict or None (None = unset). Can also be a list: [{'key': 'boot.autostart', 'value': 1}, {'key': 'security.privile...
[ "Creates", "or", "updates", "LXD", "profiles" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/lxd_profile.py#L51-L192
train
saltstack/salt
salt/states/lxd_profile.py
absent
def absent(name, remote_addr=None, cert=None, key=None, verify_cert=True): ''' Ensure a LXD profile is not present, removing it if present. name : The name of the profile to remove. remote_addr : An URL to a remote Server, you also have to give cert and key if you pr...
python
def absent(name, remote_addr=None, cert=None, key=None, verify_cert=True): ''' Ensure a LXD profile is not present, removing it if present. name : The name of the profile to remove. remote_addr : An URL to a remote Server, you also have to give cert and key if you pr...
[ "def", "absent", "(", "name", ",", "remote_addr", "=", "None", ",", "cert", "=", "None", ",", "key", "=", "None", ",", "verify_cert", "=", "True", ")", ":", "ret", "=", "{", "'name'", ":", "name", ",", "'remote_addr'", ":", "remote_addr", ",", "'cert...
Ensure a LXD profile is not present, removing it if present. name : The name of the profile to remove. remote_addr : An URL to a remote Server, you also have to give cert and key if you provide remote_addr! Examples: https://myserver.lan:8443 /var/lib/m...
[ "Ensure", "a", "LXD", "profile", "is", "not", "present", "removing", "it", "if", "present", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/lxd_profile.py#L195-L273
train
saltstack/salt
salt/modules/freebsdkmod.py
_get_persistent_modules
def _get_persistent_modules(): ''' Returns a list of modules in loader.conf that load on boot. ''' mods = set() with salt.utils.files.fopen(_LOADER_CONF, 'r') as loader_conf: for line in loader_conf: line = salt.utils.stringutils.to_unicode(line) line = line.strip() ...
python
def _get_persistent_modules(): ''' Returns a list of modules in loader.conf that load on boot. ''' mods = set() with salt.utils.files.fopen(_LOADER_CONF, 'r') as loader_conf: for line in loader_conf: line = salt.utils.stringutils.to_unicode(line) line = line.strip() ...
[ "def", "_get_persistent_modules", "(", ")", ":", "mods", "=", "set", "(", ")", "with", "salt", ".", "utils", ".", "files", ".", "fopen", "(", "_LOADER_CONF", ",", "'r'", ")", "as", "loader_conf", ":", "for", "line", "in", "loader_conf", ":", "line", "=...
Returns a list of modules in loader.conf that load on boot.
[ "Returns", "a", "list", "of", "modules", "in", "loader", ".", "conf", "that", "load", "on", "boot", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/freebsdkmod.py#L68-L80
train
saltstack/salt
salt/modules/freebsdkmod.py
_set_persistent_module
def _set_persistent_module(mod): ''' Add a module to loader.conf to make it persistent. ''' if not mod or mod in mod_list(True) or mod not in \ available(): return set() __salt__['file.append'](_LOADER_CONF, _LOAD_MODULE.format(mod)) return set([mod])
python
def _set_persistent_module(mod): ''' Add a module to loader.conf to make it persistent. ''' if not mod or mod in mod_list(True) or mod not in \ available(): return set() __salt__['file.append'](_LOADER_CONF, _LOAD_MODULE.format(mod)) return set([mod])
[ "def", "_set_persistent_module", "(", "mod", ")", ":", "if", "not", "mod", "or", "mod", "in", "mod_list", "(", "True", ")", "or", "mod", "not", "in", "available", "(", ")", ":", "return", "set", "(", ")", "__salt__", "[", "'file.append'", "]", "(", "...
Add a module to loader.conf to make it persistent.
[ "Add", "a", "module", "to", "loader", ".", "conf", "to", "make", "it", "persistent", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/freebsdkmod.py#L83-L91
train
saltstack/salt
salt/modules/freebsdkmod.py
_remove_persistent_module
def _remove_persistent_module(mod, comment): ''' Remove module from loader.conf. If comment is true only comment line where module is. ''' if not mod or mod not in mod_list(True): return set() if comment: __salt__['file.comment'](_LOADER_CONF, _MODULE_RE.format(mod)) else: ...
python
def _remove_persistent_module(mod, comment): ''' Remove module from loader.conf. If comment is true only comment line where module is. ''' if not mod or mod not in mod_list(True): return set() if comment: __salt__['file.comment'](_LOADER_CONF, _MODULE_RE.format(mod)) else: ...
[ "def", "_remove_persistent_module", "(", "mod", ",", "comment", ")", ":", "if", "not", "mod", "or", "mod", "not", "in", "mod_list", "(", "True", ")", ":", "return", "set", "(", ")", "if", "comment", ":", "__salt__", "[", "'file.comment'", "]", "(", "_L...
Remove module from loader.conf. If comment is true only comment line where module is.
[ "Remove", "module", "from", "loader", ".", "conf", ".", "If", "comment", "is", "true", "only", "comment", "line", "where", "module", "is", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/freebsdkmod.py#L94-L107
train
saltstack/salt
salt/modules/freebsdkmod.py
available
def available(): ''' Return a list of all available kernel modules CLI Example: .. code-block:: bash salt '*' kmod.available ''' ret = [] for path in __salt__['file.find']('/boot/kernel', name='*.ko$'): bpath = os.path.basename(path) comps = bpath.split('.') ...
python
def available(): ''' Return a list of all available kernel modules CLI Example: .. code-block:: bash salt '*' kmod.available ''' ret = [] for path in __salt__['file.find']('/boot/kernel', name='*.ko$'): bpath = os.path.basename(path) comps = bpath.split('.') ...
[ "def", "available", "(", ")", ":", "ret", "=", "[", "]", "for", "path", "in", "__salt__", "[", "'file.find'", "]", "(", "'/boot/kernel'", ",", "name", "=", "'*.ko$'", ")", ":", "bpath", "=", "os", ".", "path", ".", "basename", "(", "path", ")", "co...
Return a list of all available kernel modules CLI Example: .. code-block:: bash salt '*' kmod.available
[ "Return", "a", "list", "of", "all", "available", "kernel", "modules" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/freebsdkmod.py#L110-L127
train
saltstack/salt
salt/modules/freebsdkmod.py
lsmod
def lsmod(): ''' Return a dict containing information about currently loaded modules CLI Example: .. code-block:: bash salt '*' kmod.lsmod ''' ret = [] for line in __salt__['cmd.run']('kldstat').splitlines(): comps = line.split() if not len(comps) > 2: ...
python
def lsmod(): ''' Return a dict containing information about currently loaded modules CLI Example: .. code-block:: bash salt '*' kmod.lsmod ''' ret = [] for line in __salt__['cmd.run']('kldstat').splitlines(): comps = line.split() if not len(comps) > 2: ...
[ "def", "lsmod", "(", ")", ":", "ret", "=", "[", "]", "for", "line", "in", "__salt__", "[", "'cmd.run'", "]", "(", "'kldstat'", ")", ".", "splitlines", "(", ")", ":", "comps", "=", "line", ".", "split", "(", ")", "if", "not", "len", "(", "comps", ...
Return a dict containing information about currently loaded modules CLI Example: .. code-block:: bash salt '*' kmod.lsmod
[ "Return", "a", "dict", "containing", "information", "about", "currently", "loaded", "modules" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/freebsdkmod.py#L143-L167
train
saltstack/salt
salt/modules/freebsdkmod.py
mod_list
def mod_list(only_persist=False): ''' Return a list of the loaded module names CLI Example: .. code-block:: bash salt '*' kmod.mod_list ''' mods = set() if only_persist: if not _get_persistent_modules(): return mods for mod in _get_persistent_modules():...
python
def mod_list(only_persist=False): ''' Return a list of the loaded module names CLI Example: .. code-block:: bash salt '*' kmod.mod_list ''' mods = set() if only_persist: if not _get_persistent_modules(): return mods for mod in _get_persistent_modules():...
[ "def", "mod_list", "(", "only_persist", "=", "False", ")", ":", "mods", "=", "set", "(", ")", "if", "only_persist", ":", "if", "not", "_get_persistent_modules", "(", ")", ":", "return", "mods", "for", "mod", "in", "_get_persistent_modules", "(", ")", ":", ...
Return a list of the loaded module names CLI Example: .. code-block:: bash salt '*' kmod.mod_list
[ "Return", "a", "list", "of", "the", "loaded", "module", "names" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/freebsdkmod.py#L170-L189
train
saltstack/salt
salt/modules/freebsdkmod.py
load
def load(mod, persist=False): ''' Load the specified kernel module mod Name of the module to add persist Write the module to sysrc kld_modules to make it load on system reboot CLI Example: .. code-block:: bash salt '*' kmod.load bhyve ''' pre_mods = lsmod() ...
python
def load(mod, persist=False): ''' Load the specified kernel module mod Name of the module to add persist Write the module to sysrc kld_modules to make it load on system reboot CLI Example: .. code-block:: bash salt '*' kmod.load bhyve ''' pre_mods = lsmod() ...
[ "def", "load", "(", "mod", ",", "persist", "=", "False", ")", ":", "pre_mods", "=", "lsmod", "(", ")", "response", "=", "__salt__", "[", "'cmd.run_all'", "]", "(", "'kldload {0}'", ".", "format", "(", "mod", ")", ",", "python_shell", "=", "False", ")",...
Load the specified kernel module mod Name of the module to add persist Write the module to sysrc kld_modules to make it load on system reboot CLI Example: .. code-block:: bash salt '*' kmod.load bhyve
[ "Load", "the", "specified", "kernel", "module" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/freebsdkmod.py#L192-L226
train
saltstack/salt
salt/modules/freebsdkmod.py
remove
def remove(mod, persist=False, comment=True): ''' Remove the specified kernel module mod Name of module to remove persist Also remove module from /boot/loader.conf comment If persist is set don't remove line from /boot/loader.conf but only comment it CLI Examp...
python
def remove(mod, persist=False, comment=True): ''' Remove the specified kernel module mod Name of module to remove persist Also remove module from /boot/loader.conf comment If persist is set don't remove line from /boot/loader.conf but only comment it CLI Examp...
[ "def", "remove", "(", "mod", ",", "persist", "=", "False", ",", "comment", "=", "True", ")", ":", "pre_mods", "=", "lsmod", "(", ")", "res", "=", "__salt__", "[", "'cmd.run_all'", "]", "(", "'kldunload {0}'", ".", "format", "(", "mod", ")", ",", "pyt...
Remove the specified kernel module mod Name of module to remove persist Also remove module from /boot/loader.conf comment If persist is set don't remove line from /boot/loader.conf but only comment it CLI Example: .. code-block:: bash salt '*' kmod.remov...
[ "Remove", "the", "specified", "kernel", "module" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/freebsdkmod.py#L242-L273
train
saltstack/salt
salt/modules/serverdensity_device.py
get_sd_auth
def get_sd_auth(val, sd_auth_pillar_name='serverdensity'): ''' Returns requested Server Density authentication value from pillar. CLI Example: .. code-block:: bash salt '*' serverdensity_device.get_sd_auth <val> ''' sd_pillar = __pillar__.get(sd_auth_pillar_name) log.debug('Server...
python
def get_sd_auth(val, sd_auth_pillar_name='serverdensity'): ''' Returns requested Server Density authentication value from pillar. CLI Example: .. code-block:: bash salt '*' serverdensity_device.get_sd_auth <val> ''' sd_pillar = __pillar__.get(sd_auth_pillar_name) log.debug('Server...
[ "def", "get_sd_auth", "(", "val", ",", "sd_auth_pillar_name", "=", "'serverdensity'", ")", ":", "sd_pillar", "=", "__pillar__", ".", "get", "(", "sd_auth_pillar_name", ")", "log", ".", "debug", "(", "'Server Density Pillar: %s'", ",", "sd_pillar", ")", "if", "no...
Returns requested Server Density authentication value from pillar. CLI Example: .. code-block:: bash salt '*' serverdensity_device.get_sd_auth <val>
[ "Returns", "requested", "Server", "Density", "authentication", "value", "from", "pillar", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/serverdensity_device.py#L43-L65
train
saltstack/salt
salt/modules/serverdensity_device.py
_clean_salt_variables
def _clean_salt_variables(params, variable_prefix="__"): ''' Pops out variables from params which starts with `variable_prefix`. ''' list(list(map(params.pop, [k for k in params if k.startswith(variable_prefix)]))) return params
python
def _clean_salt_variables(params, variable_prefix="__"): ''' Pops out variables from params which starts with `variable_prefix`. ''' list(list(map(params.pop, [k for k in params if k.startswith(variable_prefix)]))) return params
[ "def", "_clean_salt_variables", "(", "params", ",", "variable_prefix", "=", "\"__\"", ")", ":", "list", "(", "list", "(", "map", "(", "params", ".", "pop", ",", "[", "k", "for", "k", "in", "params", "if", "k", ".", "startswith", "(", "variable_prefix", ...
Pops out variables from params which starts with `variable_prefix`.
[ "Pops", "out", "variables", "from", "params", "which", "starts", "with", "variable_prefix", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/serverdensity_device.py#L68-L73
train
saltstack/salt
salt/modules/serverdensity_device.py
create
def create(name, **params): ''' Function to create device in Server Density. For more info, see the `API docs`__. .. __: https://apidocs.serverdensity.com/Inventory/Devices/Creating CLI Example: .. code-block:: bash salt '*' serverdensity_device.create lama salt '*' serverden...
python
def create(name, **params): ''' Function to create device in Server Density. For more info, see the `API docs`__. .. __: https://apidocs.serverdensity.com/Inventory/Devices/Creating CLI Example: .. code-block:: bash salt '*' serverdensity_device.create lama salt '*' serverden...
[ "def", "create", "(", "name", ",", "*", "*", "params", ")", ":", "log", ".", "debug", "(", "'Server Density params: %s'", ",", "params", ")", "params", "=", "_clean_salt_variables", "(", "params", ")", "params", "[", "'name'", "]", "=", "name", "api_respon...
Function to create device in Server Density. For more info, see the `API docs`__. .. __: https://apidocs.serverdensity.com/Inventory/Devices/Creating CLI Example: .. code-block:: bash salt '*' serverdensity_device.create lama salt '*' serverdensity_device.create rich_lama group=lama_...
[ "Function", "to", "create", "device", "in", "Server", "Density", ".", "For", "more", "info", "see", "the", "API", "docs", "__", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/serverdensity_device.py#L76-L110
train
saltstack/salt
salt/modules/serverdensity_device.py
delete
def delete(device_id): ''' Delete a device from Server Density. For more information, see the `API docs`__. .. __: https://apidocs.serverdensity.com/Inventory/Devices/Deleting CLI Example: .. code-block:: bash salt '*' serverdensity_device.delete 51f7eafcdba4bb235e000ae4 ''' ...
python
def delete(device_id): ''' Delete a device from Server Density. For more information, see the `API docs`__. .. __: https://apidocs.serverdensity.com/Inventory/Devices/Deleting CLI Example: .. code-block:: bash salt '*' serverdensity_device.delete 51f7eafcdba4bb235e000ae4 ''' ...
[ "def", "delete", "(", "device_id", ")", ":", "api_response", "=", "requests", ".", "delete", "(", "'https://api.serverdensity.io/inventory/devices/'", "+", "device_id", ",", "params", "=", "{", "'token'", ":", "get_sd_auth", "(", "'api_token'", ")", "}", ")", "l...
Delete a device from Server Density. For more information, see the `API docs`__. .. __: https://apidocs.serverdensity.com/Inventory/Devices/Deleting CLI Example: .. code-block:: bash salt '*' serverdensity_device.delete 51f7eafcdba4bb235e000ae4
[ "Delete", "a", "device", "from", "Server", "Density", ".", "For", "more", "information", "see", "the", "API", "docs", "__", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/serverdensity_device.py#L113-L141
train
saltstack/salt
salt/modules/serverdensity_device.py
ls
def ls(**params): ''' List devices in Server Density Results will be filtered by any params passed to this function. For more information, see the API docs on listing_ and searching_. .. _listing: https://apidocs.serverdensity.com/Inventory/Devices/Listing .. _searching: https://apidocs.server...
python
def ls(**params): ''' List devices in Server Density Results will be filtered by any params passed to this function. For more information, see the API docs on listing_ and searching_. .. _listing: https://apidocs.serverdensity.com/Inventory/Devices/Listing .. _searching: https://apidocs.server...
[ "def", "ls", "(", "*", "*", "params", ")", ":", "params", "=", "_clean_salt_variables", "(", "params", ")", "endpoint", "=", "'devices'", "# Change endpoint if there are params to filter by:", "if", "params", ":", "endpoint", "=", "'resources'", "# Convert all ints to...
List devices in Server Density Results will be filtered by any params passed to this function. For more information, see the API docs on listing_ and searching_. .. _listing: https://apidocs.serverdensity.com/Inventory/Devices/Listing .. _searching: https://apidocs.serverdensity.com/Inventory/Devices/...
[ "List", "devices", "in", "Server", "Density" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/serverdensity_device.py#L144-L193
train
saltstack/salt
salt/modules/serverdensity_device.py
update
def update(device_id, **params): ''' Updates device information in Server Density. For more information see the `API docs`__. .. __: https://apidocs.serverdensity.com/Inventory/Devices/Updating CLI Example: .. code-block:: bash salt '*' serverdensity_device.update 51f7eafcdba4bb235e0...
python
def update(device_id, **params): ''' Updates device information in Server Density. For more information see the `API docs`__. .. __: https://apidocs.serverdensity.com/Inventory/Devices/Updating CLI Example: .. code-block:: bash salt '*' serverdensity_device.update 51f7eafcdba4bb235e0...
[ "def", "update", "(", "device_id", ",", "*", "*", "params", ")", ":", "params", "=", "_clean_salt_variables", "(", "params", ")", "api_response", "=", "requests", ".", "put", "(", "'https://api.serverdensity.io/inventory/devices/'", "+", "device_id", ",", "params"...
Updates device information in Server Density. For more information see the `API docs`__. .. __: https://apidocs.serverdensity.com/Inventory/Devices/Updating CLI Example: .. code-block:: bash salt '*' serverdensity_device.update 51f7eafcdba4bb235e000ae4 name=lama group=lama_band salt ...
[ "Updates", "device", "information", "in", "Server", "Density", ".", "For", "more", "information", "see", "the", "API", "docs", "__", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/serverdensity_device.py#L196-L231
train
saltstack/salt
salt/modules/serverdensity_device.py
install_agent
def install_agent(agent_key, agent_version=1): ''' Function downloads Server Density installation agent, and installs sd-agent with agent_key. Optionally the agent_version would select the series to use (defaults on the v1 one). CLI Example: .. code-block:: bash salt '*' serverdensity...
python
def install_agent(agent_key, agent_version=1): ''' Function downloads Server Density installation agent, and installs sd-agent with agent_key. Optionally the agent_version would select the series to use (defaults on the v1 one). CLI Example: .. code-block:: bash salt '*' serverdensity...
[ "def", "install_agent", "(", "agent_key", ",", "agent_version", "=", "1", ")", ":", "work_dir", "=", "os", ".", "path", ".", "join", "(", "__opts__", "[", "'cachedir'", "]", ",", "'tmp'", ")", "if", "not", "os", ".", "path", ".", "isdir", "(", "work_...
Function downloads Server Density installation agent, and installs sd-agent with agent_key. Optionally the agent_version would select the series to use (defaults on the v1 one). CLI Example: .. code-block:: bash salt '*' serverdensity_device.install_agent c2bbdd6689ff46282bdaa07555641498 ...
[ "Function", "downloads", "Server", "Density", "installation", "agent", "and", "installs", "sd", "-", "agent", "with", "agent_key", ".", "Optionally", "the", "agent_version", "would", "select", "the", "series", "to", "use", "(", "defaults", "on", "the", "v1", "...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/serverdensity_device.py#L234-L274
train
saltstack/salt
salt/cache/etcd_cache.py
_init_client
def _init_client(): '''Setup client and init datastore. ''' global client, path_prefix if client is not None: return etcd_kwargs = { 'host': __opts__.get('etcd.host', '127.0.0.1'), 'port': __opts__.get('etcd.port', 2379), 'protocol': __opts__.get('etcd.pr...
python
def _init_client(): '''Setup client and init datastore. ''' global client, path_prefix if client is not None: return etcd_kwargs = { 'host': __opts__.get('etcd.host', '127.0.0.1'), 'port': __opts__.get('etcd.port', 2379), 'protocol': __opts__.get('etcd.pr...
[ "def", "_init_client", "(", ")", ":", "global", "client", ",", "path_prefix", "if", "client", "is", "not", "None", ":", "return", "etcd_kwargs", "=", "{", "'host'", ":", "__opts__", ".", "get", "(", "'etcd.host'", ",", "'127.0.0.1'", ")", ",", "'port'", ...
Setup client and init datastore.
[ "Setup", "client", "and", "init", "datastore", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cache/etcd_cache.py#L90-L119
train
saltstack/salt
salt/cache/etcd_cache.py
store
def store(bank, key, data): ''' Store a key value. ''' _init_client() etcd_key = '{0}/{1}/{2}'.format(path_prefix, bank, key) try: value = __context__['serial'].dumps(data) client.write(etcd_key, base64.b64encode(value)) except Exception as exc: raise SaltCacheError( ...
python
def store(bank, key, data): ''' Store a key value. ''' _init_client() etcd_key = '{0}/{1}/{2}'.format(path_prefix, bank, key) try: value = __context__['serial'].dumps(data) client.write(etcd_key, base64.b64encode(value)) except Exception as exc: raise SaltCacheError( ...
[ "def", "store", "(", "bank", ",", "key", ",", "data", ")", ":", "_init_client", "(", ")", "etcd_key", "=", "'{0}/{1}/{2}'", ".", "format", "(", "path_prefix", ",", "bank", ",", "key", ")", "try", ":", "value", "=", "__context__", "[", "'serial'", "]", ...
Store a key value.
[ "Store", "a", "key", "value", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cache/etcd_cache.py#L122-L134
train
saltstack/salt
salt/cache/etcd_cache.py
fetch
def fetch(bank, key): ''' Fetch a key value. ''' _init_client() etcd_key = '{0}/{1}/{2}'.format(path_prefix, bank, key) try: value = client.read(etcd_key).value return __context__['serial'].loads(base64.b64decode(value)) except etcd.EtcdKeyNotFound: return {} exce...
python
def fetch(bank, key): ''' Fetch a key value. ''' _init_client() etcd_key = '{0}/{1}/{2}'.format(path_prefix, bank, key) try: value = client.read(etcd_key).value return __context__['serial'].loads(base64.b64decode(value)) except etcd.EtcdKeyNotFound: return {} exce...
[ "def", "fetch", "(", "bank", ",", "key", ")", ":", "_init_client", "(", ")", "etcd_key", "=", "'{0}/{1}/{2}'", ".", "format", "(", "path_prefix", ",", "bank", ",", "key", ")", "try", ":", "value", "=", "client", ".", "read", "(", "etcd_key", ")", "."...
Fetch a key value.
[ "Fetch", "a", "key", "value", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cache/etcd_cache.py#L137-L153
train
saltstack/salt
salt/cache/etcd_cache.py
flush
def flush(bank, key=None): ''' Remove the key from the cache bank with all the key content. ''' _init_client() if key is None: etcd_key = '{0}/{1}'.format(path_prefix, bank) else: etcd_key = '{0}/{1}/{2}'.format(path_prefix, bank, key) try: client.read(etcd_key) e...
python
def flush(bank, key=None): ''' Remove the key from the cache bank with all the key content. ''' _init_client() if key is None: etcd_key = '{0}/{1}'.format(path_prefix, bank) else: etcd_key = '{0}/{1}/{2}'.format(path_prefix, bank, key) try: client.read(etcd_key) e...
[ "def", "flush", "(", "bank", ",", "key", "=", "None", ")", ":", "_init_client", "(", ")", "if", "key", "is", "None", ":", "etcd_key", "=", "'{0}/{1}'", ".", "format", "(", "path_prefix", ",", "bank", ")", "else", ":", "etcd_key", "=", "'{0}/{1}/{2}'", ...
Remove the key from the cache bank with all the key content.
[ "Remove", "the", "key", "from", "the", "cache", "bank", "with", "all", "the", "key", "content", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cache/etcd_cache.py#L156-L176
train
saltstack/salt
salt/cache/etcd_cache.py
_walk
def _walk(r): ''' Recursively walk dirs. Return flattened list of keys. r: etcd.EtcdResult ''' if not r.dir: return [r.key.split('/', 3)[3]] keys = [] for c in client.read(r.key).children: keys.extend(_walk(c)) return keys
python
def _walk(r): ''' Recursively walk dirs. Return flattened list of keys. r: etcd.EtcdResult ''' if not r.dir: return [r.key.split('/', 3)[3]] keys = [] for c in client.read(r.key).children: keys.extend(_walk(c)) return keys
[ "def", "_walk", "(", "r", ")", ":", "if", "not", "r", ".", "dir", ":", "return", "[", "r", ".", "key", ".", "split", "(", "'/'", ",", "3", ")", "[", "3", "]", "]", "keys", "=", "[", "]", "for", "c", "in", "client", ".", "read", "(", "r", ...
Recursively walk dirs. Return flattened list of keys. r: etcd.EtcdResult
[ "Recursively", "walk", "dirs", ".", "Return", "flattened", "list", "of", "keys", ".", "r", ":", "etcd", ".", "EtcdResult" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cache/etcd_cache.py#L179-L190
train
saltstack/salt
salt/cache/etcd_cache.py
ls
def ls(bank): ''' Return an iterable object containing all entries stored in the specified bank. ''' _init_client() path = '{0}/{1}'.format(path_prefix, bank) try: return _walk(client.read(path)) except Exception as exc: raise SaltCacheError( 'There was an err...
python
def ls(bank): ''' Return an iterable object containing all entries stored in the specified bank. ''' _init_client() path = '{0}/{1}'.format(path_prefix, bank) try: return _walk(client.read(path)) except Exception as exc: raise SaltCacheError( 'There was an err...
[ "def", "ls", "(", "bank", ")", ":", "_init_client", "(", ")", "path", "=", "'{0}/{1}'", ".", "format", "(", "path_prefix", ",", "bank", ")", "try", ":", "return", "_walk", "(", "client", ".", "read", "(", "path", ")", ")", "except", "Exception", "as"...
Return an iterable object containing all entries stored in the specified bank.
[ "Return", "an", "iterable", "object", "containing", "all", "entries", "stored", "in", "the", "specified", "bank", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cache/etcd_cache.py#L193-L207
train
saltstack/salt
salt/cache/etcd_cache.py
contains
def contains(bank, key): ''' Checks if the specified bank contains the specified key. ''' _init_client() etcd_key = '{0}/{1}/{2}'.format(path_prefix, bank, key) try: r = client.read(etcd_key) # return True for keys, not dirs return r.dir is False except etcd.EtcdKeyNo...
python
def contains(bank, key): ''' Checks if the specified bank contains the specified key. ''' _init_client() etcd_key = '{0}/{1}/{2}'.format(path_prefix, bank, key) try: r = client.read(etcd_key) # return True for keys, not dirs return r.dir is False except etcd.EtcdKeyNo...
[ "def", "contains", "(", "bank", ",", "key", ")", ":", "_init_client", "(", ")", "etcd_key", "=", "'{0}/{1}/{2}'", ".", "format", "(", "path_prefix", ",", "bank", ",", "key", ")", "try", ":", "r", "=", "client", ".", "read", "(", "etcd_key", ")", "# r...
Checks if the specified bank contains the specified key.
[ "Checks", "if", "the", "specified", "bank", "contains", "the", "specified", "key", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/cache/etcd_cache.py#L210-L227
train
saltstack/salt
salt/modules/udev.py
_parse_udevadm_info
def _parse_udevadm_info(udev_info): ''' Parse the info returned by udevadm command. ''' devices = [] dev = {} for line in (line.strip() for line in udev_info.splitlines()): if line: line = line.split(':', 1) if len(line) != 2: continue ...
python
def _parse_udevadm_info(udev_info): ''' Parse the info returned by udevadm command. ''' devices = [] dev = {} for line in (line.strip() for line in udev_info.splitlines()): if line: line = line.split(':', 1) if len(line) != 2: continue ...
[ "def", "_parse_udevadm_info", "(", "udev_info", ")", ":", "devices", "=", "[", "]", "dev", "=", "{", "}", "for", "line", "in", "(", "line", ".", "strip", "(", ")", "for", "line", "in", "udev_info", ".", "splitlines", "(", ")", ")", ":", "if", "line...
Parse the info returned by udevadm command.
[ "Parse", "the", "info", "returned", "by", "udevadm", "command", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/udev.py#L31-L70
train
saltstack/salt
salt/modules/udev.py
_normalize_info
def _normalize_info(dev): ''' Replace list with only one element to the value of the element. :param dev: :return: ''' for sect, val in dev.items(): if len(val) == 1: dev[sect] = val[0] return dev
python
def _normalize_info(dev): ''' Replace list with only one element to the value of the element. :param dev: :return: ''' for sect, val in dev.items(): if len(val) == 1: dev[sect] = val[0] return dev
[ "def", "_normalize_info", "(", "dev", ")", ":", "for", "sect", ",", "val", "in", "dev", ".", "items", "(", ")", ":", "if", "len", "(", "val", ")", "==", "1", ":", "dev", "[", "sect", "]", "=", "val", "[", "0", "]", "return", "dev" ]
Replace list with only one element to the value of the element. :param dev: :return:
[ "Replace", "list", "with", "only", "one", "element", "to", "the", "value", "of", "the", "element", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/udev.py#L73-L84
train
saltstack/salt
salt/modules/udev.py
info
def info(dev): ''' Extract all info delivered by udevadm CLI Example: .. code-block:: bash salt '*' udev.info /dev/sda salt '*' udev.info /sys/class/net/eth0 ''' if 'sys' in dev: qtype = 'path' else: qtype = 'name' cmd = 'udevadm info --export --query=...
python
def info(dev): ''' Extract all info delivered by udevadm CLI Example: .. code-block:: bash salt '*' udev.info /dev/sda salt '*' udev.info /sys/class/net/eth0 ''' if 'sys' in dev: qtype = 'path' else: qtype = 'name' cmd = 'udevadm info --export --query=...
[ "def", "info", "(", "dev", ")", ":", "if", "'sys'", "in", "dev", ":", "qtype", "=", "'path'", "else", ":", "qtype", "=", "'name'", "cmd", "=", "'udevadm info --export --query=all --{0}={1}'", ".", "format", "(", "qtype", ",", "dev", ")", "udev_result", "="...
Extract all info delivered by udevadm CLI Example: .. code-block:: bash salt '*' udev.info /dev/sda salt '*' udev.info /sys/class/net/eth0
[ "Extract", "all", "info", "delivered", "by", "udevadm" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/udev.py#L87-L109
train
saltstack/salt
salt/modules/udev.py
exportdb
def exportdb(): ''' Return all the udev database CLI Example: .. code-block:: bash salt '*' udev.exportdb ''' cmd = 'udevadm info --export-db' udev_result = __salt__['cmd.run_all'](cmd, output_loglevel='quiet') if udev_result['retcode']: raise CommandExecutionError(u...
python
def exportdb(): ''' Return all the udev database CLI Example: .. code-block:: bash salt '*' udev.exportdb ''' cmd = 'udevadm info --export-db' udev_result = __salt__['cmd.run_all'](cmd, output_loglevel='quiet') if udev_result['retcode']: raise CommandExecutionError(u...
[ "def", "exportdb", "(", ")", ":", "cmd", "=", "'udevadm info --export-db'", "udev_result", "=", "__salt__", "[", "'cmd.run_all'", "]", "(", "cmd", ",", "output_loglevel", "=", "'quiet'", ")", "if", "udev_result", "[", "'retcode'", "]", ":", "raise", "CommandEx...
Return all the udev database CLI Example: .. code-block:: bash salt '*' udev.exportdb
[ "Return", "all", "the", "udev", "database" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/udev.py#L168-L185
train
saltstack/salt
salt/modules/mac_timezone.py
_get_date_time_format
def _get_date_time_format(dt_string): ''' Function that detects the date/time format for the string passed. :param str dt_string: A date/time string :return: The format of the passed dt_string :rtype: str :raises: SaltInvocationError on Invalid Date/Time string ''' valid_forma...
python
def _get_date_time_format(dt_string): ''' Function that detects the date/time format for the string passed. :param str dt_string: A date/time string :return: The format of the passed dt_string :rtype: str :raises: SaltInvocationError on Invalid Date/Time string ''' valid_forma...
[ "def", "_get_date_time_format", "(", "dt_string", ")", ":", "valid_formats", "=", "[", "'%H:%M'", ",", "'%H:%M:%S'", ",", "'%m:%d:%y'", ",", "'%m:%d:%Y'", ",", "'%m/%d/%y'", ",", "'%m/%d/%Y'", "]", "for", "dt_format", "in", "valid_formats", ":", "try", ":", "d...
Function that detects the date/time format for the string passed. :param str dt_string: A date/time string :return: The format of the passed dt_string :rtype: str :raises: SaltInvocationError on Invalid Date/Time string
[ "Function", "that", "detects", "the", "date", "/", "time", "format", "for", "the", "string", "passed", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_timezone.py#L31-L58
train
saltstack/salt
salt/modules/mac_timezone.py
get_date
def get_date(): ''' Displays the current date :return: the system date :rtype: str CLI Example: .. code-block:: bash salt '*' timezone.get_date ''' ret = salt.utils.mac_utils.execute_return_result('systemsetup -getdate') return salt.utils.mac_utils.parse_return(ret)
python
def get_date(): ''' Displays the current date :return: the system date :rtype: str CLI Example: .. code-block:: bash salt '*' timezone.get_date ''' ret = salt.utils.mac_utils.execute_return_result('systemsetup -getdate') return salt.utils.mac_utils.parse_return(ret)
[ "def", "get_date", "(", ")", ":", "ret", "=", "salt", ".", "utils", ".", "mac_utils", ".", "execute_return_result", "(", "'systemsetup -getdate'", ")", "return", "salt", ".", "utils", ".", "mac_utils", ".", "parse_return", "(", "ret", ")" ]
Displays the current date :return: the system date :rtype: str CLI Example: .. code-block:: bash salt '*' timezone.get_date
[ "Displays", "the", "current", "date" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_timezone.py#L61-L75
train
saltstack/salt
salt/modules/mac_timezone.py
set_date
def set_date(date): ''' Set the current month, day, and year :param str date: The date to set. Valid date formats are: - %m:%d:%y - %m:%d:%Y - %m/%d/%y - %m/%d/%Y :return: True if successful, False if not :rtype: bool :raises: SaltInvocationError on Invalid Da...
python
def set_date(date): ''' Set the current month, day, and year :param str date: The date to set. Valid date formats are: - %m:%d:%y - %m:%d:%Y - %m/%d/%y - %m/%d/%Y :return: True if successful, False if not :rtype: bool :raises: SaltInvocationError on Invalid Da...
[ "def", "set_date", "(", "date", ")", ":", "date_format", "=", "_get_date_time_format", "(", "date", ")", "dt_obj", "=", "datetime", ".", "strptime", "(", "date", ",", "date_format", ")", "cmd", "=", "'systemsetup -setdate {0}'", ".", "format", "(", "dt_obj", ...
Set the current month, day, and year :param str date: The date to set. Valid date formats are: - %m:%d:%y - %m:%d:%Y - %m/%d/%y - %m/%d/%Y :return: True if successful, False if not :rtype: bool :raises: SaltInvocationError on Invalid Date format :raises: CommandEx...
[ "Set", "the", "current", "month", "day", "and", "year" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_timezone.py#L78-L105
train
saltstack/salt
salt/modules/mac_timezone.py
get_time
def get_time(): ''' Get the current system time. :return: The current time in 24 hour format :rtype: str CLI Example: .. code-block:: bash salt '*' timezone.get_time ''' ret = salt.utils.mac_utils.execute_return_result('systemsetup -gettime') return salt.utils.mac_utils.p...
python
def get_time(): ''' Get the current system time. :return: The current time in 24 hour format :rtype: str CLI Example: .. code-block:: bash salt '*' timezone.get_time ''' ret = salt.utils.mac_utils.execute_return_result('systemsetup -gettime') return salt.utils.mac_utils.p...
[ "def", "get_time", "(", ")", ":", "ret", "=", "salt", ".", "utils", ".", "mac_utils", ".", "execute_return_result", "(", "'systemsetup -gettime'", ")", "return", "salt", ".", "utils", ".", "mac_utils", ".", "parse_return", "(", "ret", ")" ]
Get the current system time. :return: The current time in 24 hour format :rtype: str CLI Example: .. code-block:: bash salt '*' timezone.get_time
[ "Get", "the", "current", "system", "time", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_timezone.py#L108-L122
train
saltstack/salt
salt/modules/mac_timezone.py
set_time
def set_time(time): ''' Sets the current time. Must be in 24 hour format. :param str time: The time to set in 24 hour format. The value must be double quoted. ie: '"17:46"' :return: True if successful, False if not :rtype: bool :raises: SaltInvocationError on Invalid Time format ...
python
def set_time(time): ''' Sets the current time. Must be in 24 hour format. :param str time: The time to set in 24 hour format. The value must be double quoted. ie: '"17:46"' :return: True if successful, False if not :rtype: bool :raises: SaltInvocationError on Invalid Time format ...
[ "def", "set_time", "(", "time", ")", ":", "# time must be double quoted '\"17:46\"'", "time_format", "=", "_get_date_time_format", "(", "time", ")", "dt_obj", "=", "datetime", ".", "strptime", "(", "time", ",", "time_format", ")", "cmd", "=", "'systemsetup -settime ...
Sets the current time. Must be in 24 hour format. :param str time: The time to set in 24 hour format. The value must be double quoted. ie: '"17:46"' :return: True if successful, False if not :rtype: bool :raises: SaltInvocationError on Invalid Time format :raises: CommandExecutionError o...
[ "Sets", "the", "current", "time", ".", "Must", "be", "in", "24", "hour", "format", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_timezone.py#L125-L149
train
saltstack/salt
salt/modules/mac_timezone.py
get_zone
def get_zone(): ''' Displays the current time zone :return: The current time zone :rtype: str CLI Example: .. code-block:: bash salt '*' timezone.get_zone ''' ret = salt.utils.mac_utils.execute_return_result('systemsetup -gettimezone') return salt.utils.mac_utils.parse_re...
python
def get_zone(): ''' Displays the current time zone :return: The current time zone :rtype: str CLI Example: .. code-block:: bash salt '*' timezone.get_zone ''' ret = salt.utils.mac_utils.execute_return_result('systemsetup -gettimezone') return salt.utils.mac_utils.parse_re...
[ "def", "get_zone", "(", ")", ":", "ret", "=", "salt", ".", "utils", ".", "mac_utils", ".", "execute_return_result", "(", "'systemsetup -gettimezone'", ")", "return", "salt", ".", "utils", ".", "mac_utils", ".", "parse_return", "(", "ret", ")" ]
Displays the current time zone :return: The current time zone :rtype: str CLI Example: .. code-block:: bash salt '*' timezone.get_zone
[ "Displays", "the", "current", "time", "zone" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_timezone.py#L152-L166
train
saltstack/salt
salt/modules/mac_timezone.py
list_zones
def list_zones(): ''' Displays a list of available time zones. Use this list when setting a time zone using ``timezone.set_zone`` :return: a list of time zones :rtype: list CLI Example: .. code-block:: bash salt '*' timezone.list_zones ''' ret = salt.utils.mac_utils.execu...
python
def list_zones(): ''' Displays a list of available time zones. Use this list when setting a time zone using ``timezone.set_zone`` :return: a list of time zones :rtype: list CLI Example: .. code-block:: bash salt '*' timezone.list_zones ''' ret = salt.utils.mac_utils.execu...
[ "def", "list_zones", "(", ")", ":", "ret", "=", "salt", ".", "utils", ".", "mac_utils", ".", "execute_return_result", "(", "'systemsetup -listtimezones'", ")", "zones", "=", "salt", ".", "utils", ".", "mac_utils", ".", "parse_return", "(", "ret", ")", "retur...
Displays a list of available time zones. Use this list when setting a time zone using ``timezone.set_zone`` :return: a list of time zones :rtype: list CLI Example: .. code-block:: bash salt '*' timezone.list_zones
[ "Displays", "a", "list", "of", "available", "time", "zones", ".", "Use", "this", "list", "when", "setting", "a", "time", "zone", "using", "timezone", ".", "set_zone" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_timezone.py#L201-L219
train
saltstack/salt
salt/modules/mac_timezone.py
set_zone
def set_zone(time_zone): ''' Set the local time zone. Use ``timezone.list_zones`` to list valid time_zone arguments :param str time_zone: The time zone to apply :return: True if successful, False if not :rtype: bool :raises: SaltInvocationError on Invalid Timezone :raises: CommandExec...
python
def set_zone(time_zone): ''' Set the local time zone. Use ``timezone.list_zones`` to list valid time_zone arguments :param str time_zone: The time zone to apply :return: True if successful, False if not :rtype: bool :raises: SaltInvocationError on Invalid Timezone :raises: CommandExec...
[ "def", "set_zone", "(", "time_zone", ")", ":", "if", "time_zone", "not", "in", "list_zones", "(", ")", ":", "raise", "SaltInvocationError", "(", "'Invalid Timezone: {0}'", ".", "format", "(", "time_zone", ")", ")", "salt", ".", "utils", ".", "mac_utils", "."...
Set the local time zone. Use ``timezone.list_zones`` to list valid time_zone arguments :param str time_zone: The time zone to apply :return: True if successful, False if not :rtype: bool :raises: SaltInvocationError on Invalid Timezone :raises: CommandExecutionError on failure CLI Exampl...
[ "Set", "the", "local", "time", "zone", ".", "Use", "timezone", ".", "list_zones", "to", "list", "valid", "time_zone", "arguments" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_timezone.py#L222-L247
train
saltstack/salt
salt/modules/mac_timezone.py
get_using_network_time
def get_using_network_time(): ''' Display whether network time is on or off :return: True if network time is on, False if off :rtype: bool CLI Example: .. code-block:: bash salt '*' timezone.get_using_network_time ''' ret = salt.utils.mac_utils.execute_return_result( ...
python
def get_using_network_time(): ''' Display whether network time is on or off :return: True if network time is on, False if off :rtype: bool CLI Example: .. code-block:: bash salt '*' timezone.get_using_network_time ''' ret = salt.utils.mac_utils.execute_return_result( ...
[ "def", "get_using_network_time", "(", ")", ":", "ret", "=", "salt", ".", "utils", ".", "mac_utils", ".", "execute_return_result", "(", "'systemsetup -getusingnetworktime'", ")", "return", "salt", ".", "utils", ".", "mac_utils", ".", "validate_enabled", "(", "salt"...
Display whether network time is on or off :return: True if network time is on, False if off :rtype: bool CLI Example: .. code-block:: bash salt '*' timezone.get_using_network_time
[ "Display", "whether", "network", "time", "is", "on", "or", "off" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_timezone.py#L266-L283
train
saltstack/salt
salt/modules/mac_timezone.py
set_using_network_time
def set_using_network_time(enable): ''' Set whether network time is on or off. :param enable: True to enable, False to disable. Can also use 'on' or 'off' :type: str bool :return: True if successful, False if not :rtype: bool :raises: CommandExecutionError on failure CLI Example: ...
python
def set_using_network_time(enable): ''' Set whether network time is on or off. :param enable: True to enable, False to disable. Can also use 'on' or 'off' :type: str bool :return: True if successful, False if not :rtype: bool :raises: CommandExecutionError on failure CLI Example: ...
[ "def", "set_using_network_time", "(", "enable", ")", ":", "state", "=", "salt", ".", "utils", ".", "mac_utils", ".", "validate_enabled", "(", "enable", ")", "cmd", "=", "'systemsetup -setusingnetworktime {0}'", ".", "format", "(", "state", ")", "salt", ".", "u...
Set whether network time is on or off. :param enable: True to enable, False to disable. Can also use 'on' or 'off' :type: str bool :return: True if successful, False if not :rtype: bool :raises: CommandExecutionError on failure CLI Example: .. code-block:: bash salt '*' timezon...
[ "Set", "whether", "network", "time", "is", "on", "or", "off", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_timezone.py#L286-L310
train
saltstack/salt
salt/modules/mac_timezone.py
get_time_server
def get_time_server(): ''' Display the currently set network time server. :return: the network time server :rtype: str CLI Example: .. code-block:: bash salt '*' timezone.get_time_server ''' ret = salt.utils.mac_utils.execute_return_result( 'systemsetup -getnetworktim...
python
def get_time_server(): ''' Display the currently set network time server. :return: the network time server :rtype: str CLI Example: .. code-block:: bash salt '*' timezone.get_time_server ''' ret = salt.utils.mac_utils.execute_return_result( 'systemsetup -getnetworktim...
[ "def", "get_time_server", "(", ")", ":", "ret", "=", "salt", ".", "utils", ".", "mac_utils", ".", "execute_return_result", "(", "'systemsetup -getnetworktimeserver'", ")", "return", "salt", ".", "utils", ".", "mac_utils", ".", "parse_return", "(", "ret", ")" ]
Display the currently set network time server. :return: the network time server :rtype: str CLI Example: .. code-block:: bash salt '*' timezone.get_time_server
[ "Display", "the", "currently", "set", "network", "time", "server", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_timezone.py#L313-L328
train
saltstack/salt
salt/modules/mac_timezone.py
set_time_server
def set_time_server(time_server='time.apple.com'): ''' Designates a network time server. Enter the IP address or DNS name for the network time server. :param time_server: IP or DNS name of the network time server. If nothing is passed the time server will be set to the macOS default of ...
python
def set_time_server(time_server='time.apple.com'): ''' Designates a network time server. Enter the IP address or DNS name for the network time server. :param time_server: IP or DNS name of the network time server. If nothing is passed the time server will be set to the macOS default of ...
[ "def", "set_time_server", "(", "time_server", "=", "'time.apple.com'", ")", ":", "cmd", "=", "'systemsetup -setnetworktimeserver {0}'", ".", "format", "(", "time_server", ")", "salt", ".", "utils", ".", "mac_utils", ".", "execute_return_success", "(", "cmd", ")", ...
Designates a network time server. Enter the IP address or DNS name for the network time server. :param time_server: IP or DNS name of the network time server. If nothing is passed the time server will be set to the macOS default of 'time.apple.com' :type: str :return: True if successfu...
[ "Designates", "a", "network", "time", "server", ".", "Enter", "the", "IP", "address", "or", "DNS", "name", "for", "the", "network", "time", "server", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mac_timezone.py#L331-L355
train
saltstack/salt
salt/modules/nexus.py
get_snapshot
def get_snapshot(nexus_url, repository, group_id, artifact_id, packaging, version, snapshot_version=None, target_dir='/tmp', target_file=None, classifier=None, username=None, password=None): ''' Gets snapshot of the desired version of the artifact nexus_url URL of nexus instance rep...
python
def get_snapshot(nexus_url, repository, group_id, artifact_id, packaging, version, snapshot_version=None, target_dir='/tmp', target_file=None, classifier=None, username=None, password=None): ''' Gets snapshot of the desired version of the artifact nexus_url URL of nexus instance rep...
[ "def", "get_snapshot", "(", "nexus_url", ",", "repository", ",", "group_id", ",", "artifact_id", ",", "packaging", ",", "version", ",", "snapshot_version", "=", "None", ",", "target_dir", "=", "'/tmp'", ",", "target_file", "=", "None", ",", "classifier", "=", ...
Gets snapshot of the desired version of the artifact nexus_url URL of nexus instance repository Snapshot repository in nexus to retrieve artifact from, for example: libs-snapshots group_id Group Id of the artifact artifact_id Artifact Id of the ar...
[ "Gets", "snapshot", "of", "the", "desired", "version", "of", "the", "artifact" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/nexus.py#L83-L118
train
saltstack/salt
salt/modules/nexus.py
get_snapshot_version_string
def get_snapshot_version_string(nexus_url, repository, group_id, artifact_id, packaging, version, classifier=None, username=None, password=None): ''' Gets the specific version string of a snapshot of the desired version of the artifact nexus_url URL of nexus instance repository ...
python
def get_snapshot_version_string(nexus_url, repository, group_id, artifact_id, packaging, version, classifier=None, username=None, password=None): ''' Gets the specific version string of a snapshot of the desired version of the artifact nexus_url URL of nexus instance repository ...
[ "def", "get_snapshot_version_string", "(", "nexus_url", ",", "repository", ",", "group_id", ",", "artifact_id", ",", "packaging", ",", "version", ",", "classifier", "=", "None", ",", "username", "=", "None", ",", "password", "=", "None", ")", ":", "log", "."...
Gets the specific version string of a snapshot of the desired version of the artifact nexus_url URL of nexus instance repository Snapshot repository in nexus to retrieve artifact from, for example: libs-snapshots group_id Group Id of the artifact artifact_id...
[ "Gets", "the", "specific", "version", "string", "of", "a", "snapshot", "of", "the", "desired", "version", "of", "the", "artifact" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/nexus.py#L121-L149
train
saltstack/salt
salt/sdb/yaml.py
get
def get(key, profile=None): # pylint: disable=W0613 ''' Get a value from the dictionary ''' data = _get_values(profile) # Decrypt SDB data if specified in the profile if profile and profile.get('gpg', False): return salt.utils.data.traverse_dict_and_list(_decrypt(data), key, None) ...
python
def get(key, profile=None): # pylint: disable=W0613 ''' Get a value from the dictionary ''' data = _get_values(profile) # Decrypt SDB data if specified in the profile if profile and profile.get('gpg', False): return salt.utils.data.traverse_dict_and_list(_decrypt(data), key, None) ...
[ "def", "get", "(", "key", ",", "profile", "=", "None", ")", ":", "# pylint: disable=W0613", "data", "=", "_get_values", "(", "profile", ")", "# Decrypt SDB data if specified in the profile", "if", "profile", "and", "profile", ".", "get", "(", "'gpg'", ",", "Fals...
Get a value from the dictionary
[ "Get", "a", "value", "from", "the", "dictionary" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/sdb/yaml.py#L71-L81
train
saltstack/salt
salt/sdb/yaml.py
_get_values
def _get_values(profile=None): ''' Retrieve all the referenced files, deserialize, then merge them together ''' profile = profile or {} serializers = salt.loader.serializers(__opts__) ret = {} for fname in profile.get('files', []): try: with salt.utils.files.flopen(fname...
python
def _get_values(profile=None): ''' Retrieve all the referenced files, deserialize, then merge them together ''' profile = profile or {} serializers = salt.loader.serializers(__opts__) ret = {} for fname in profile.get('files', []): try: with salt.utils.files.flopen(fname...
[ "def", "_get_values", "(", "profile", "=", "None", ")", ":", "profile", "=", "profile", "or", "{", "}", "serializers", "=", "salt", ".", "loader", ".", "serializers", "(", "__opts__", ")", "ret", "=", "{", "}", "for", "fname", "in", "profile", ".", "...
Retrieve all the referenced files, deserialize, then merge them together
[ "Retrieve", "all", "the", "referenced", "files", "deserialize", "then", "merge", "them", "together" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/sdb/yaml.py#L84-L102
train
saltstack/salt
salt/states/zabbix_host.py
present
def present(host, groups, interfaces, **kwargs): ''' Ensures that the host exists, eventually creates new host. NOTE: please use argument visible_name instead of name to not mess with name from salt sls. This function accepts all standard host properties: keyword argument names differ depending on your ...
python
def present(host, groups, interfaces, **kwargs): ''' Ensures that the host exists, eventually creates new host. NOTE: please use argument visible_name instead of name to not mess with name from salt sls. This function accepts all standard host properties: keyword argument names differ depending on your ...
[ "def", "present", "(", "host", ",", "groups", ",", "interfaces", ",", "*", "*", "kwargs", ")", ":", "connection_args", "=", "{", "}", "if", "'_connection_user'", "in", "kwargs", ":", "connection_args", "[", "'_connection_user'", "]", "=", "kwargs", "[", "'...
Ensures that the host exists, eventually creates new host. NOTE: please use argument visible_name instead of name to not mess with name from salt sls. This function accepts all standard host properties: keyword argument names differ depending on your zabbix version, see: https://www.zabbix.com/documentation...
[ "Ensures", "that", "the", "host", "exists", "eventually", "creates", "new", "host", ".", "NOTE", ":", "please", "use", "argument", "visible_name", "instead", "of", "name", "to", "not", "mess", "with", "name", "from", "salt", "sls", ".", "This", "function", ...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zabbix_host.py#L22-L337
train
saltstack/salt
salt/states/zabbix_host.py
absent
def absent(name, **kwargs): """ Ensures that the host does not exists, eventually deletes host. .. versionadded:: 2016.3.0 :param: name: technical name of the host :param _connection_user: Optional - zabbix user (can also be set in opts or pillar, see module's docstring) :param _connection_pas...
python
def absent(name, **kwargs): """ Ensures that the host does not exists, eventually deletes host. .. versionadded:: 2016.3.0 :param: name: technical name of the host :param _connection_user: Optional - zabbix user (can also be set in opts or pillar, see module's docstring) :param _connection_pas...
[ "def", "absent", "(", "name", ",", "*", "*", "kwargs", ")", ":", "ret", "=", "{", "'name'", ":", "name", ",", "'changes'", ":", "{", "}", ",", "'result'", ":", "False", ",", "'comment'", ":", "''", "}", "# Comment and change messages", "comment_host_dele...
Ensures that the host does not exists, eventually deletes host. .. versionadded:: 2016.3.0 :param: name: technical name of the host :param _connection_user: Optional - zabbix user (can also be set in opts or pillar, see module's docstring) :param _connection_password: Optional - zabbix password (can a...
[ "Ensures", "that", "the", "host", "does", "not", "exists", "eventually", "deletes", "host", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zabbix_host.py#L340-L407
train
saltstack/salt
salt/states/zabbix_host.py
assign_templates
def assign_templates(host, templates, **kwargs): ''' Ensures that templates are assigned to the host. .. versionadded:: 2017.7.0 :param host: technical name of the host :param _connection_user: Optional - zabbix user (can also be set in opts or pillar, see module's docstring) :param _connectio...
python
def assign_templates(host, templates, **kwargs): ''' Ensures that templates are assigned to the host. .. versionadded:: 2017.7.0 :param host: technical name of the host :param _connection_user: Optional - zabbix user (can also be set in opts or pillar, see module's docstring) :param _connectio...
[ "def", "assign_templates", "(", "host", ",", "templates", ",", "*", "*", "kwargs", ")", ":", "connection_args", "=", "{", "}", "if", "'_connection_user'", "in", "kwargs", ":", "connection_args", "[", "'_connection_user'", "]", "=", "kwargs", "[", "'_connection...
Ensures that templates are assigned to the host. .. versionadded:: 2017.7.0 :param host: technical name of the host :param _connection_user: Optional - zabbix user (can also be set in opts or pillar, see module's docstring) :param _connection_password: Optional - zabbix password (can also be set in op...
[ "Ensures", "that", "templates", "are", "assigned", "to", "the", "host", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/zabbix_host.py#L410-L516
train
saltstack/salt
salt/proxy/cimc.py
init
def init(opts): ''' This function gets called when the proxy starts up. ''' if 'host' not in opts['proxy']: log.critical('No \'host\' key found in pillar for this proxy.') return False if 'username' not in opts['proxy']: log.critical('No \'username\' key found in pillar for t...
python
def init(opts): ''' This function gets called when the proxy starts up. ''' if 'host' not in opts['proxy']: log.critical('No \'host\' key found in pillar for this proxy.') return False if 'username' not in opts['proxy']: log.critical('No \'username\' key found in pillar for t...
[ "def", "init", "(", "opts", ")", ":", "if", "'host'", "not", "in", "opts", "[", "'proxy'", "]", ":", "log", ".", "critical", "(", "'No \\'host\\' key found in pillar for this proxy.'", ")", "return", "False", "if", "'username'", "not", "in", "opts", "[", "'p...
This function gets called when the proxy starts up.
[ "This", "function", "gets", "called", "when", "the", "proxy", "starts", "up", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/proxy/cimc.py#L110-L139
train
saltstack/salt
salt/proxy/cimc.py
set_config_modify
def set_config_modify(dn=None, inconfig=None, hierarchical=False): ''' The configConfMo method configures the specified managed object in a single subtree (for example, DN). ''' ret = {} cookie = logon() # Declare if the search contains hierarchical results. h = "false" if hierarchical ...
python
def set_config_modify(dn=None, inconfig=None, hierarchical=False): ''' The configConfMo method configures the specified managed object in a single subtree (for example, DN). ''' ret = {} cookie = logon() # Declare if the search contains hierarchical results. h = "false" if hierarchical ...
[ "def", "set_config_modify", "(", "dn", "=", "None", ",", "inconfig", "=", "None", ",", "hierarchical", "=", "False", ")", ":", "ret", "=", "{", "}", "cookie", "=", "logon", "(", ")", "# Declare if the search contains hierarchical results.", "h", "=", "\"false\...
The configConfMo method configures the specified managed object in a single subtree (for example, DN).
[ "The", "configConfMo", "method", "configures", "the", "specified", "managed", "object", "in", "a", "single", "subtree", "(", "for", "example", "DN", ")", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/proxy/cimc.py#L142-L173
train
saltstack/salt
salt/proxy/cimc.py
logon
def logon(): ''' Logs into the cimc device and returns the session cookie. ''' content = {} payload = "<aaaLogin inName='{0}' inPassword='{1}'></aaaLogin>".format(DETAILS['username'], DETAILS['password']) r = __utils__['http.query'](DETAILS['url'], data=payload, ...
python
def logon(): ''' Logs into the cimc device and returns the session cookie. ''' content = {} payload = "<aaaLogin inName='{0}' inPassword='{1}'></aaaLogin>".format(DETAILS['username'], DETAILS['password']) r = __utils__['http.query'](DETAILS['url'], data=payload, ...
[ "def", "logon", "(", ")", ":", "content", "=", "{", "}", "payload", "=", "\"<aaaLogin inName='{0}' inPassword='{1}'></aaaLogin>\"", ".", "format", "(", "DETAILS", "[", "'username'", "]", ",", "DETAILS", "[", "'password'", "]", ")", "r", "=", "__utils__", "[", ...
Logs into the cimc device and returns the session cookie.
[ "Logs", "into", "the", "cimc", "device", "and", "returns", "the", "session", "cookie", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/proxy/cimc.py#L210-L236
train
saltstack/salt
salt/proxy/cimc.py
logout
def logout(cookie=None): ''' Closes the session with the device. ''' payload = '<aaaLogout cookie="{0}" inCookie="{0}"></aaaLogout>'.format(cookie) __utils__['http.query'](DETAILS['url'], data=payload, method='POST', ...
python
def logout(cookie=None): ''' Closes the session with the device. ''' payload = '<aaaLogout cookie="{0}" inCookie="{0}"></aaaLogout>'.format(cookie) __utils__['http.query'](DETAILS['url'], data=payload, method='POST', ...
[ "def", "logout", "(", "cookie", "=", "None", ")", ":", "payload", "=", "'<aaaLogout cookie=\"{0}\" inCookie=\"{0}\"></aaaLogout>'", ".", "format", "(", "cookie", ")", "__utils__", "[", "'http.query'", "]", "(", "DETAILS", "[", "'url'", "]", ",", "data", "=", "...
Closes the session with the device.
[ "Closes", "the", "session", "with", "the", "device", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/proxy/cimc.py#L239-L252
train
saltstack/salt
salt/proxy/cimc.py
prepare_return
def prepare_return(x): ''' Converts the etree to dict ''' ret = {} for a in list(x): if a.tag not in ret: ret[a.tag] = [] ret[a.tag].append(prepare_return(a)) for a in x.attrib: ret[a] = x.attrib[a] return ret
python
def prepare_return(x): ''' Converts the etree to dict ''' ret = {} for a in list(x): if a.tag not in ret: ret[a.tag] = [] ret[a.tag].append(prepare_return(a)) for a in x.attrib: ret[a] = x.attrib[a] return ret
[ "def", "prepare_return", "(", "x", ")", ":", "ret", "=", "{", "}", "for", "a", "in", "list", "(", "x", ")", ":", "if", "a", ".", "tag", "not", "in", "ret", ":", "ret", "[", "a", ".", "tag", "]", "=", "[", "]", "ret", "[", "a", ".", "tag",...
Converts the etree to dict
[ "Converts", "the", "etree", "to", "dict" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/proxy/cimc.py#L255-L266
train
saltstack/salt
salt/proxy/cimc.py
grains
def grains(): ''' Get the grains from the proxied device ''' if not DETAILS.get('grains_cache', {}): DETAILS['grains_cache'] = GRAINS_CACHE try: compute_rack = get_config_resolver_class('computeRackUnit', False) DETAILS['grains_cache'] = compute_rack['outConfigs']...
python
def grains(): ''' Get the grains from the proxied device ''' if not DETAILS.get('grains_cache', {}): DETAILS['grains_cache'] = GRAINS_CACHE try: compute_rack = get_config_resolver_class('computeRackUnit', False) DETAILS['grains_cache'] = compute_rack['outConfigs']...
[ "def", "grains", "(", ")", ":", "if", "not", "DETAILS", ".", "get", "(", "'grains_cache'", ",", "{", "}", ")", ":", "DETAILS", "[", "'grains_cache'", "]", "=", "GRAINS_CACHE", "try", ":", "compute_rack", "=", "get_config_resolver_class", "(", "'computeRackUn...
Get the grains from the proxied device
[ "Get", "the", "grains", "from", "the", "proxied", "device" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/proxy/cimc.py#L278-L291
train
saltstack/salt
salt/proxy/cimc.py
ping
def ping(): ''' Returns true if the device is reachable, else false. ''' try: cookie = logon() logout(cookie) except salt.exceptions.CommandExecutionError: return False except Exception as err: log.debug(err) return False return True
python
def ping(): ''' Returns true if the device is reachable, else false. ''' try: cookie = logon() logout(cookie) except salt.exceptions.CommandExecutionError: return False except Exception as err: log.debug(err) return False return True
[ "def", "ping", "(", ")", ":", "try", ":", "cookie", "=", "logon", "(", ")", "logout", "(", "cookie", ")", "except", "salt", ".", "exceptions", ".", "CommandExecutionError", ":", "return", "False", "except", "Exception", "as", "err", ":", "log", ".", "d...
Returns true if the device is reachable, else false.
[ "Returns", "true", "if", "the", "device", "is", "reachable", "else", "false", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/proxy/cimc.py#L302-L314
train
saltstack/salt
salt/utils/files.py
guess_archive_type
def guess_archive_type(name): ''' Guess an archive type (tar, zip, or rar) by its file extension ''' name = name.lower() for ending in ('tar', 'tar.gz', 'tgz', 'tar.bz2', 'tbz2', 'tbz', 'tar.xz', 'txz', 'tar.lzma', 'tlz'): if name.ends...
python
def guess_archive_type(name): ''' Guess an archive type (tar, zip, or rar) by its file extension ''' name = name.lower() for ending in ('tar', 'tar.gz', 'tgz', 'tar.bz2', 'tbz2', 'tbz', 'tar.xz', 'txz', 'tar.lzma', 'tlz'): if name.ends...
[ "def", "guess_archive_type", "(", "name", ")", ":", "name", "=", "name", ".", "lower", "(", ")", "for", "ending", "in", "(", "'tar'", ",", "'tar.gz'", ",", "'tgz'", ",", "'tar.bz2'", ",", "'tbz2'", ",", "'tbz'", ",", "'tar.xz'", ",", "'txz'", ",", "'...
Guess an archive type (tar, zip, or rar) by its file extension
[ "Guess", "an", "archive", "type", "(", "tar", "zip", "or", "rar", ")", "by", "its", "file", "extension" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L68-L82
train
saltstack/salt
salt/utils/files.py
mkstemp
def mkstemp(*args, **kwargs): ''' Helper function which does exactly what ``tempfile.mkstemp()`` does but accepts another argument, ``close_fd``, which, by default, is true and closes the fd before returning the file path. Something commonly done throughout Salt's code. ''' if 'prefix' not i...
python
def mkstemp(*args, **kwargs): ''' Helper function which does exactly what ``tempfile.mkstemp()`` does but accepts another argument, ``close_fd``, which, by default, is true and closes the fd before returning the file path. Something commonly done throughout Salt's code. ''' if 'prefix' not i...
[ "def", "mkstemp", "(", "*", "args", ",", "*", "*", "kwargs", ")", ":", "if", "'prefix'", "not", "in", "kwargs", ":", "kwargs", "[", "'prefix'", "]", "=", "'__salt.tmp.'", "close_fd", "=", "kwargs", ".", "pop", "(", "'close_fd'", ",", "True", ")", "fd...
Helper function which does exactly what ``tempfile.mkstemp()`` does but accepts another argument, ``close_fd``, which, by default, is true and closes the fd before returning the file path. Something commonly done throughout Salt's code.
[ "Helper", "function", "which", "does", "exactly", "what", "tempfile", ".", "mkstemp", "()", "does", "but", "accepts", "another", "argument", "close_fd", "which", "by", "default", "is", "true", "and", "closes", "the", "fd", "before", "returning", "the", "file",...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L85-L100
train
saltstack/salt
salt/utils/files.py
recursive_copy
def recursive_copy(source, dest): ''' Recursively copy the source directory to the destination, leaving files with the source does not explicitly overwrite. (identical to cp -r on a unix machine) ''' for root, _, files in salt.utils.path.os_walk(source): path_from_source = root.replace(...
python
def recursive_copy(source, dest): ''' Recursively copy the source directory to the destination, leaving files with the source does not explicitly overwrite. (identical to cp -r on a unix machine) ''' for root, _, files in salt.utils.path.os_walk(source): path_from_source = root.replace(...
[ "def", "recursive_copy", "(", "source", ",", "dest", ")", ":", "for", "root", ",", "_", ",", "files", "in", "salt", ".", "utils", ".", "path", ".", "os_walk", "(", "source", ")", ":", "path_from_source", "=", "root", ".", "replace", "(", "source", ",...
Recursively copy the source directory to the destination, leaving files with the source does not explicitly overwrite. (identical to cp -r on a unix machine)
[ "Recursively", "copy", "the", "source", "directory", "to", "the", "destination", "leaving", "files", "with", "the", "source", "does", "not", "explicitly", "overwrite", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L103-L118
train
saltstack/salt
salt/utils/files.py
copyfile
def copyfile(source, dest, backup_mode='', cachedir=''): ''' Copy files from a source to a destination in an atomic way, and if specified cache the file. ''' if not os.path.isfile(source): raise IOError( '[Errno 2] No such file or directory: {0}'.format(source) ) if n...
python
def copyfile(source, dest, backup_mode='', cachedir=''): ''' Copy files from a source to a destination in an atomic way, and if specified cache the file. ''' if not os.path.isfile(source): raise IOError( '[Errno 2] No such file or directory: {0}'.format(source) ) if n...
[ "def", "copyfile", "(", "source", ",", "dest", ",", "backup_mode", "=", "''", ",", "cachedir", "=", "''", ")", ":", "if", "not", "os", ".", "path", ".", "isfile", "(", "source", ")", ":", "raise", "IOError", "(", "'[Errno 2] No such file or directory: {0}'...
Copy files from a source to a destination in an atomic way, and if specified cache the file.
[ "Copy", "files", "from", "a", "source", "to", "a", "destination", "in", "an", "atomic", "way", "and", "if", "specified", "cache", "the", "file", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L121-L181
train
saltstack/salt
salt/utils/files.py
rename
def rename(src, dst): ''' On Windows, os.rename() will fail with a WindowsError exception if a file exists at the destination path. This function checks for this error and if found, it deletes the destination path first. ''' try: os.rename(src, dst) except OSError as exc: if ...
python
def rename(src, dst): ''' On Windows, os.rename() will fail with a WindowsError exception if a file exists at the destination path. This function checks for this error and if found, it deletes the destination path first. ''' try: os.rename(src, dst) except OSError as exc: if ...
[ "def", "rename", "(", "src", ",", "dst", ")", ":", "try", ":", "os", ".", "rename", "(", "src", ",", "dst", ")", "except", "OSError", "as", "exc", ":", "if", "exc", ".", "errno", "!=", "errno", ".", "EEXIST", ":", "raise", "try", ":", "os", "."...
On Windows, os.rename() will fail with a WindowsError exception if a file exists at the destination path. This function checks for this error and if found, it deletes the destination path first.
[ "On", "Windows", "os", ".", "rename", "()", "will", "fail", "with", "a", "WindowsError", "exception", "if", "a", "file", "exists", "at", "the", "destination", "path", ".", "This", "function", "checks", "for", "this", "error", "and", "if", "found", "it", ...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L184-L205
train
saltstack/salt
salt/utils/files.py
process_read_exception
def process_read_exception(exc, path, ignore=None): ''' Common code for raising exceptions when reading a file fails The ignore argument can be an iterable of integer error codes (or a single integer error code) that should be ignored. ''' if ignore is not None: if isinstance(ignore, si...
python
def process_read_exception(exc, path, ignore=None): ''' Common code for raising exceptions when reading a file fails The ignore argument can be an iterable of integer error codes (or a single integer error code) that should be ignored. ''' if ignore is not None: if isinstance(ignore, si...
[ "def", "process_read_exception", "(", "exc", ",", "path", ",", "ignore", "=", "None", ")", ":", "if", "ignore", "is", "not", "None", ":", "if", "isinstance", "(", "ignore", ",", "six", ".", "integer_types", ")", ":", "ignore", "=", "(", "ignore", ",", ...
Common code for raising exceptions when reading a file fails The ignore argument can be an iterable of integer error codes (or a single integer error code) that should be ignored.
[ "Common", "code", "for", "raising", "exceptions", "when", "reading", "a", "file", "fails" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L208-L235
train
saltstack/salt
salt/utils/files.py
wait_lock
def wait_lock(path, lock_fn=None, timeout=5, sleep=0.1, time_start=None): ''' Obtain a write lock. If one exists, wait for it to release first ''' if not isinstance(path, six.string_types): raise FileLockError('path must be a string') if lock_fn is None: lock_fn = path + '.w' if ...
python
def wait_lock(path, lock_fn=None, timeout=5, sleep=0.1, time_start=None): ''' Obtain a write lock. If one exists, wait for it to release first ''' if not isinstance(path, six.string_types): raise FileLockError('path must be a string') if lock_fn is None: lock_fn = path + '.w' if ...
[ "def", "wait_lock", "(", "path", ",", "lock_fn", "=", "None", ",", "timeout", "=", "5", ",", "sleep", "=", "0.1", ",", "time_start", "=", "None", ")", ":", "if", "not", "isinstance", "(", "path", ",", "six", ".", "string_types", ")", ":", "raise", ...
Obtain a write lock. If one exists, wait for it to release first
[ "Obtain", "a", "write", "lock", ".", "If", "one", "exists", "wait", "for", "it", "to", "release", "first" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L239-L312
train
saltstack/salt
salt/utils/files.py
set_umask
def set_umask(mask): ''' Temporarily set the umask and restore once the contextmanager exits ''' if mask is None or salt.utils.platform.is_windows(): # Don't attempt on Windows, or if no mask was passed yield else: try: orig_mask = os.umask(mask) # pylint: disabl...
python
def set_umask(mask): ''' Temporarily set the umask and restore once the contextmanager exits ''' if mask is None or salt.utils.platform.is_windows(): # Don't attempt on Windows, or if no mask was passed yield else: try: orig_mask = os.umask(mask) # pylint: disabl...
[ "def", "set_umask", "(", "mask", ")", ":", "if", "mask", "is", "None", "or", "salt", ".", "utils", ".", "platform", ".", "is_windows", "(", ")", ":", "# Don't attempt on Windows, or if no mask was passed", "yield", "else", ":", "try", ":", "orig_mask", "=", ...
Temporarily set the umask and restore once the contextmanager exits
[ "Temporarily", "set", "the", "umask", "and", "restore", "once", "the", "contextmanager", "exits" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L325-L337
train
saltstack/salt
salt/utils/files.py
fopen
def fopen(*args, **kwargs): ''' Wrapper around open() built-in to set CLOEXEC on the fd. This flag specifies that the file descriptor should be closed when an exec function is invoked; When a file descriptor is allocated (as with open or dup), this bit is initially cleared on the new file desc...
python
def fopen(*args, **kwargs): ''' Wrapper around open() built-in to set CLOEXEC on the fd. This flag specifies that the file descriptor should be closed when an exec function is invoked; When a file descriptor is allocated (as with open or dup), this bit is initially cleared on the new file desc...
[ "def", "fopen", "(", "*", "args", ",", "*", "*", "kwargs", ")", ":", "if", "six", ".", "PY3", ":", "try", ":", "# Don't permit stdin/stdout/stderr to be opened. The boolean False", "# and True are treated by Python 3's open() as file descriptors 0", "# and 1, respectively.", ...
Wrapper around open() built-in to set CLOEXEC on the fd. This flag specifies that the file descriptor should be closed when an exec function is invoked; When a file descriptor is allocated (as with open or dup), this bit is initially cleared on the new file descriptor, meaning that descriptor will ...
[ "Wrapper", "around", "open", "()", "built", "-", "in", "to", "set", "CLOEXEC", "on", "the", "fd", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L340-L411
train
saltstack/salt
salt/utils/files.py
flopen
def flopen(*args, **kwargs): ''' Shortcut for fopen with lock and context manager. ''' filename, args = args[0], args[1:] writing = 'wa' with fopen(filename, *args, **kwargs) as f_handle: try: if is_fcntl_available(check_sunos=True): lock_type = fcntl.LOCK_SH ...
python
def flopen(*args, **kwargs): ''' Shortcut for fopen with lock and context manager. ''' filename, args = args[0], args[1:] writing = 'wa' with fopen(filename, *args, **kwargs) as f_handle: try: if is_fcntl_available(check_sunos=True): lock_type = fcntl.LOCK_SH ...
[ "def", "flopen", "(", "*", "args", ",", "*", "*", "kwargs", ")", ":", "filename", ",", "args", "=", "args", "[", "0", "]", ",", "args", "[", "1", ":", "]", "writing", "=", "'wa'", "with", "fopen", "(", "filename", ",", "*", "args", ",", "*", ...
Shortcut for fopen with lock and context manager.
[ "Shortcut", "for", "fopen", "with", "lock", "and", "context", "manager", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L415-L431
train
saltstack/salt
salt/utils/files.py
fpopen
def fpopen(*args, **kwargs): ''' Shortcut for fopen with extra uid, gid, and mode options. Supported optional Keyword Arguments: mode Explicit mode to set. Mode is anything os.chmod would accept as input for mode. Works only on unix/unix-like systems. uid The uid to set, i...
python
def fpopen(*args, **kwargs): ''' Shortcut for fopen with extra uid, gid, and mode options. Supported optional Keyword Arguments: mode Explicit mode to set. Mode is anything os.chmod would accept as input for mode. Works only on unix/unix-like systems. uid The uid to set, i...
[ "def", "fpopen", "(", "*", "args", ",", "*", "*", "kwargs", ")", ":", "# Remove uid, gid and mode from kwargs if present", "uid", "=", "kwargs", ".", "pop", "(", "'uid'", ",", "-", "1", ")", "# -1 means no change to current uid", "gid", "=", "kwargs", ".", "po...
Shortcut for fopen with extra uid, gid, and mode options. Supported optional Keyword Arguments: mode Explicit mode to set. Mode is anything os.chmod would accept as input for mode. Works only on unix/unix-like systems. uid The uid to set, if not set, or it is None or -1 no changes...
[ "Shortcut", "for", "fopen", "with", "extra", "uid", "gid", "and", "mode", "options", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L435-L476
train
saltstack/salt
salt/utils/files.py
safe_walk
def safe_walk(top, topdown=True, onerror=None, followlinks=True, _seen=None): ''' A clone of the python os.walk function with some checks for recursive symlinks. Unlike os.walk this follows symlinks by default. ''' if _seen is None: _seen = set() # We may not have read permission for to...
python
def safe_walk(top, topdown=True, onerror=None, followlinks=True, _seen=None): ''' A clone of the python os.walk function with some checks for recursive symlinks. Unlike os.walk this follows symlinks by default. ''' if _seen is None: _seen = set() # We may not have read permission for to...
[ "def", "safe_walk", "(", "top", ",", "topdown", "=", "True", ",", "onerror", "=", "None", ",", "followlinks", "=", "True", ",", "_seen", "=", "None", ")", ":", "if", "_seen", "is", "None", ":", "_seen", "=", "set", "(", ")", "# We may not have read per...
A clone of the python os.walk function with some checks for recursive symlinks. Unlike os.walk this follows symlinks by default.
[ "A", "clone", "of", "the", "python", "os", ".", "walk", "function", "with", "some", "checks", "for", "recursive", "symlinks", ".", "Unlike", "os", ".", "walk", "this", "follows", "symlinks", "by", "default", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L479-L526
train
saltstack/salt
salt/utils/files.py
rm_rf
def rm_rf(path): ''' Platform-independent recursive delete. Includes code from http://stackoverflow.com/a/2656405 ''' def _onerror(func, path, exc_info): ''' Error handler for `shutil.rmtree`. If the error is due to an access error (read only file) it attempts to add...
python
def rm_rf(path): ''' Platform-independent recursive delete. Includes code from http://stackoverflow.com/a/2656405 ''' def _onerror(func, path, exc_info): ''' Error handler for `shutil.rmtree`. If the error is due to an access error (read only file) it attempts to add...
[ "def", "rm_rf", "(", "path", ")", ":", "def", "_onerror", "(", "func", ",", "path", ",", "exc_info", ")", ":", "'''\n Error handler for `shutil.rmtree`.\n\n If the error is due to an access error (read only file)\n it attempts to add write permission and then ret...
Platform-independent recursive delete. Includes code from http://stackoverflow.com/a/2656405
[ "Platform", "-", "independent", "recursive", "delete", ".", "Includes", "code", "from", "http", ":", "//", "stackoverflow", ".", "com", "/", "a", "/", "2656405" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L539-L569
train
saltstack/salt
salt/utils/files.py
is_fcntl_available
def is_fcntl_available(check_sunos=False): ''' Simple function to check if the ``fcntl`` module is available or not. If ``check_sunos`` is passed as ``True`` an additional check to see if host is SunOS is also made. For additional information see: http://goo.gl/159FF8 ''' if check_sunos and sal...
python
def is_fcntl_available(check_sunos=False): ''' Simple function to check if the ``fcntl`` module is available or not. If ``check_sunos`` is passed as ``True`` an additional check to see if host is SunOS is also made. For additional information see: http://goo.gl/159FF8 ''' if check_sunos and sal...
[ "def", "is_fcntl_available", "(", "check_sunos", "=", "False", ")", ":", "if", "check_sunos", "and", "salt", ".", "utils", ".", "platform", ".", "is_sunos", "(", ")", ":", "return", "False", "return", "HAS_FCNTL" ]
Simple function to check if the ``fcntl`` module is available or not. If ``check_sunos`` is passed as ``True`` an additional check to see if host is SunOS is also made. For additional information see: http://goo.gl/159FF8
[ "Simple", "function", "to", "check", "if", "the", "fcntl", "module", "is", "available", "or", "not", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L584-L593
train
saltstack/salt
salt/utils/files.py
safe_filename_leaf
def safe_filename_leaf(file_basename): ''' Input the basename of a file, without the directory tree, and returns a safe name to use i.e. only the required characters are converted by urllib.quote If the input is a PY2 String, output a PY2 String. If input is Unicode output Unicode. For consistency a...
python
def safe_filename_leaf(file_basename): ''' Input the basename of a file, without the directory tree, and returns a safe name to use i.e. only the required characters are converted by urllib.quote If the input is a PY2 String, output a PY2 String. If input is Unicode output Unicode. For consistency a...
[ "def", "safe_filename_leaf", "(", "file_basename", ")", ":", "def", "_replace", "(", "re_obj", ")", ":", "return", "quote", "(", "re_obj", ".", "group", "(", "0", ")", ",", "safe", "=", "''", ")", "if", "not", "isinstance", "(", "file_basename", ",", "...
Input the basename of a file, without the directory tree, and returns a safe name to use i.e. only the required characters are converted by urllib.quote If the input is a PY2 String, output a PY2 String. If input is Unicode output Unicode. For consistency all platforms are treated the same. Hard coded to ut...
[ "Input", "the", "basename", "of", "a", "file", "without", "the", "directory", "tree", "and", "returns", "a", "safe", "name", "to", "use", "i", ".", "e", ".", "only", "the", "required", "characters", "are", "converted", "by", "urllib", ".", "quote", "If",...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L596-L616
train
saltstack/salt
salt/utils/files.py
safe_filepath
def safe_filepath(file_path_name, dir_sep=None): ''' Input the full path and filename, splits on directory separator and calls safe_filename_leaf for each part of the path. dir_sep allows coder to force a directory separate to a particular character .. versionadded:: 2017.7.2 :codeauthor: Damon At...
python
def safe_filepath(file_path_name, dir_sep=None): ''' Input the full path and filename, splits on directory separator and calls safe_filename_leaf for each part of the path. dir_sep allows coder to force a directory separate to a particular character .. versionadded:: 2017.7.2 :codeauthor: Damon At...
[ "def", "safe_filepath", "(", "file_path_name", ",", "dir_sep", "=", "None", ")", ":", "if", "not", "dir_sep", ":", "dir_sep", "=", "os", ".", "sep", "# Normally if file_path_name or dir_sep is Unicode then the output will be Unicode", "# This code ensure the output type is th...
Input the full path and filename, splits on directory separator and calls safe_filename_leaf for each part of the path. dir_sep allows coder to force a directory separate to a particular character .. versionadded:: 2017.7.2 :codeauthor: Damon Atkins <https://github.com/damon-atkins>
[ "Input", "the", "full", "path", "and", "filename", "splits", "on", "directory", "separator", "and", "calls", "safe_filename_leaf", "for", "each", "part", "of", "the", "path", ".", "dir_sep", "allows", "coder", "to", "force", "a", "directory", "separate", "to",...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L619-L639
train
saltstack/salt
salt/utils/files.py
is_text
def is_text(fp_, blocksize=512): ''' Uses heuristics to guess whether the given file is text or binary, by reading a single block of bytes from the file. If more than 30% of the chars in the block are non-text, or there are NUL ('\x00') bytes in the block, assume this is a binary file. ''' i...
python
def is_text(fp_, blocksize=512): ''' Uses heuristics to guess whether the given file is text or binary, by reading a single block of bytes from the file. If more than 30% of the chars in the block are non-text, or there are NUL ('\x00') bytes in the block, assume this is a binary file. ''' i...
[ "def", "is_text", "(", "fp_", ",", "blocksize", "=", "512", ")", ":", "int2byte", "=", "(", "lambda", "x", ":", "bytes", "(", "(", "x", ",", ")", ")", ")", "if", "six", ".", "PY3", "else", "chr", "text_characters", "=", "(", "b''", ".", "join", ...
Uses heuristics to guess whether the given file is text or binary, by reading a single block of bytes from the file. If more than 30% of the chars in the block are non-text, or there are NUL ('\x00') bytes in the block, assume this is a binary file.
[ "Uses", "heuristics", "to", "guess", "whether", "the", "given", "file", "is", "text", "or", "binary", "by", "reading", "a", "single", "block", "of", "bytes", "from", "the", "file", ".", "If", "more", "than", "30%", "of", "the", "chars", "in", "the", "b...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L643-L678
train
saltstack/salt
salt/utils/files.py
is_binary
def is_binary(path): ''' Detects if the file is a binary, returns bool. Returns True if the file is a bin, False if the file is not and None if the file is not available. ''' if not os.path.isfile(path): return False try: with fopen(path, 'rb') as fp_: try: ...
python
def is_binary(path): ''' Detects if the file is a binary, returns bool. Returns True if the file is a bin, False if the file is not and None if the file is not available. ''' if not os.path.isfile(path): return False try: with fopen(path, 'rb') as fp_: try: ...
[ "def", "is_binary", "(", "path", ")", ":", "if", "not", "os", ".", "path", ".", "isfile", "(", "path", ")", ":", "return", "False", "try", ":", "with", "fopen", "(", "path", ",", "'rb'", ")", "as", "fp_", ":", "try", ":", "data", "=", "fp_", "....
Detects if the file is a binary, returns bool. Returns True if the file is a bin, False if the file is not and None if the file is not available.
[ "Detects", "if", "the", "file", "is", "a", "binary", "returns", "bool", ".", "Returns", "True", "if", "the", "file", "is", "a", "bin", "False", "if", "the", "file", "is", "not", "and", "None", "if", "the", "file", "is", "not", "available", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L682-L699
train
saltstack/salt
salt/utils/files.py
remove
def remove(path): ''' Runs os.remove(path) and suppresses the OSError if the file doesn't exist ''' try: os.remove(path) except OSError as exc: if exc.errno != errno.ENOENT: raise
python
def remove(path): ''' Runs os.remove(path) and suppresses the OSError if the file doesn't exist ''' try: os.remove(path) except OSError as exc: if exc.errno != errno.ENOENT: raise
[ "def", "remove", "(", "path", ")", ":", "try", ":", "os", ".", "remove", "(", "path", ")", "except", "OSError", "as", "exc", ":", "if", "exc", ".", "errno", "!=", "errno", ".", "ENOENT", ":", "raise" ]
Runs os.remove(path) and suppresses the OSError if the file doesn't exist
[ "Runs", "os", ".", "remove", "(", "path", ")", "and", "suppresses", "the", "OSError", "if", "the", "file", "doesn", "t", "exist" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L702-L710
train
saltstack/salt
salt/utils/files.py
list_files
def list_files(directory): ''' Return a list of all files found under directory (and its subdirectories) ''' ret = set() ret.add(directory) for root, dirs, files in safe_walk(directory): for name in files: ret.add(os.path.join(root, name)) for name in dirs: ...
python
def list_files(directory): ''' Return a list of all files found under directory (and its subdirectories) ''' ret = set() ret.add(directory) for root, dirs, files in safe_walk(directory): for name in files: ret.add(os.path.join(root, name)) for name in dirs: ...
[ "def", "list_files", "(", "directory", ")", ":", "ret", "=", "set", "(", ")", "ret", ".", "add", "(", "directory", ")", "for", "root", ",", "dirs", ",", "files", "in", "safe_walk", "(", "directory", ")", ":", "for", "name", "in", "files", ":", "ret...
Return a list of all files found under directory (and its subdirectories)
[ "Return", "a", "list", "of", "all", "files", "found", "under", "directory", "(", "and", "its", "subdirectories", ")" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L714-L726
train
saltstack/salt
salt/utils/files.py
normalize_mode
def normalize_mode(mode): ''' Return a mode value, normalized to a string and containing a leading zero if it does not have one. Allow "keep" as a valid mode (used by file state/module to preserve mode from the Salt fileserver in file states). ''' if mode is None: return None if...
python
def normalize_mode(mode): ''' Return a mode value, normalized to a string and containing a leading zero if it does not have one. Allow "keep" as a valid mode (used by file state/module to preserve mode from the Salt fileserver in file states). ''' if mode is None: return None if...
[ "def", "normalize_mode", "(", "mode", ")", ":", "if", "mode", "is", "None", ":", "return", "None", "if", "not", "isinstance", "(", "mode", ",", "six", ".", "string_types", ")", ":", "mode", "=", "six", ".", "text_type", "(", "mode", ")", "if", "six",...
Return a mode value, normalized to a string and containing a leading zero if it does not have one. Allow "keep" as a valid mode (used by file state/module to preserve mode from the Salt fileserver in file states).
[ "Return", "a", "mode", "value", "normalized", "to", "a", "string", "and", "containing", "a", "leading", "zero", "if", "it", "does", "not", "have", "one", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L740-L756
train
saltstack/salt
salt/utils/files.py
human_size_to_bytes
def human_size_to_bytes(human_size): ''' Convert human-readable units to bytes ''' size_exp_map = {'K': 1, 'M': 2, 'G': 3, 'T': 4, 'P': 5} human_size_str = six.text_type(human_size) match = re.match(r'^(\d+)([KMGTP])?$', human_size_str) if not match: raise ValueError( 'Si...
python
def human_size_to_bytes(human_size): ''' Convert human-readable units to bytes ''' size_exp_map = {'K': 1, 'M': 2, 'G': 3, 'T': 4, 'P': 5} human_size_str = six.text_type(human_size) match = re.match(r'^(\d+)([KMGTP])?$', human_size_str) if not match: raise ValueError( 'Si...
[ "def", "human_size_to_bytes", "(", "human_size", ")", ":", "size_exp_map", "=", "{", "'K'", ":", "1", ",", "'M'", ":", "2", ",", "'G'", ":", "3", ",", "'T'", ":", "4", ",", "'P'", ":", "5", "}", "human_size_str", "=", "six", ".", "text_type", "(", ...
Convert human-readable units to bytes
[ "Convert", "human", "-", "readable", "units", "to", "bytes" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L759-L773
train
saltstack/salt
salt/utils/files.py
backup_minion
def backup_minion(path, bkroot): ''' Backup a file on the minion ''' dname, bname = os.path.split(path) if salt.utils.platform.is_windows(): src_dir = dname.replace(':', '_') else: src_dir = dname[1:] if not salt.utils.platform.is_windows(): fstat = os.stat(path) ...
python
def backup_minion(path, bkroot): ''' Backup a file on the minion ''' dname, bname = os.path.split(path) if salt.utils.platform.is_windows(): src_dir = dname.replace(':', '_') else: src_dir = dname[1:] if not salt.utils.platform.is_windows(): fstat = os.stat(path) ...
[ "def", "backup_minion", "(", "path", ",", "bkroot", ")", ":", "dname", ",", "bname", "=", "os", ".", "path", ".", "split", "(", "path", ")", "if", "salt", ".", "utils", ".", "platform", ".", "is_windows", "(", ")", ":", "src_dir", "=", "dname", "."...
Backup a file on the minion
[ "Backup", "a", "file", "on", "the", "minion" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L776-L802
train
saltstack/salt
salt/utils/files.py
get_encoding
def get_encoding(path): ''' Detect a file's encoding using the following: - Check for Byte Order Marks (BOM) - Check for UTF-8 Markers - Check System Encoding - Check for ascii Args: path (str): The path to the file to check Returns: str: The encoding of the file ...
python
def get_encoding(path): ''' Detect a file's encoding using the following: - Check for Byte Order Marks (BOM) - Check for UTF-8 Markers - Check System Encoding - Check for ascii Args: path (str): The path to the file to check Returns: str: The encoding of the file ...
[ "def", "get_encoding", "(", "path", ")", ":", "def", "check_ascii", "(", "_data", ")", ":", "# If all characters can be decoded to ASCII, then it's ASCII", "try", ":", "_data", ".", "decode", "(", "'ASCII'", ")", "log", ".", "debug", "(", "'Found ASCII'", ")", "...
Detect a file's encoding using the following: - Check for Byte Order Marks (BOM) - Check for UTF-8 Markers - Check System Encoding - Check for ascii Args: path (str): The path to the file to check Returns: str: The encoding of the file Raises: CommandExecutionErro...
[ "Detect", "a", "file", "s", "encoding", "using", "the", "following", ":", "-", "Check", "for", "Byte", "Order", "Marks", "(", "BOM", ")", "-", "Check", "for", "UTF", "-", "8", "Markers", "-", "Check", "System", "Encoding", "-", "Check", "for", "ascii" ...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/files.py#L805-L901
train
saltstack/salt
salt/states/grafana4_dashboard.py
absent
def absent(name, orgname=None, profile='grafana'): ''' Ensure the named grafana dashboard is absent. name Name of the grafana dashboard. orgname Name of the organization in which the dashboard should be present. profile Configuration profile used to connect to the Grafana ...
python
def absent(name, orgname=None, profile='grafana'): ''' Ensure the named grafana dashboard is absent. name Name of the grafana dashboard. orgname Name of the organization in which the dashboard should be present. profile Configuration profile used to connect to the Grafana ...
[ "def", "absent", "(", "name", ",", "orgname", "=", "None", ",", "profile", "=", "'grafana'", ")", ":", "ret", "=", "{", "'name'", ":", "name", ",", "'result'", ":", "True", ",", "'comment'", ":", "''", ",", "'changes'", ":", "{", "}", "}", "if", ...
Ensure the named grafana dashboard is absent. name Name of the grafana dashboard. orgname Name of the organization in which the dashboard should be present. profile Configuration profile used to connect to the Grafana instance. Default is 'grafana'.
[ "Ensure", "the", "named", "grafana", "dashboard", "is", "absent", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/grafana4_dashboard.py#L212-L245
train
saltstack/salt
salt/grains/zfs.py
_zfs_pool_data
def _zfs_pool_data(): ''' Provide grains about zpools ''' grains = {} # collect zpool data zpool_list_cmd = __utils__['zfs.zpool_command']( 'list', flags=['-H'], opts={'-o': 'name,size'}, ) for zpool in __salt__['cmd.run'](zpool_list_cmd, ignore_retcode=True).spl...
python
def _zfs_pool_data(): ''' Provide grains about zpools ''' grains = {} # collect zpool data zpool_list_cmd = __utils__['zfs.zpool_command']( 'list', flags=['-H'], opts={'-o': 'name,size'}, ) for zpool in __salt__['cmd.run'](zpool_list_cmd, ignore_retcode=True).spl...
[ "def", "_zfs_pool_data", "(", ")", ":", "grains", "=", "{", "}", "# collect zpool data", "zpool_list_cmd", "=", "__utils__", "[", "'zfs.zpool_command'", "]", "(", "'list'", ",", "flags", "=", "[", "'-H'", "]", ",", "opts", "=", "{", "'-o'", ":", "'name,siz...
Provide grains about zpools
[ "Provide", "grains", "about", "zpools" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/grains/zfs.py#L54-L73
train
saltstack/salt
salt/grains/zfs.py
zfs
def zfs(): ''' Provide grains for zfs/zpool ''' grains = {} grains['zfs_support'] = __utils__['zfs.is_supported']() grains['zfs_feature_flags'] = __utils__['zfs.has_feature_flags']() if grains['zfs_support']: grains = salt.utils.dictupdate.update(grains, _zfs_pool_data(), merge_lists...
python
def zfs(): ''' Provide grains for zfs/zpool ''' grains = {} grains['zfs_support'] = __utils__['zfs.is_supported']() grains['zfs_feature_flags'] = __utils__['zfs.has_feature_flags']() if grains['zfs_support']: grains = salt.utils.dictupdate.update(grains, _zfs_pool_data(), merge_lists...
[ "def", "zfs", "(", ")", ":", "grains", "=", "{", "}", "grains", "[", "'zfs_support'", "]", "=", "__utils__", "[", "'zfs.is_supported'", "]", "(", ")", "grains", "[", "'zfs_feature_flags'", "]", "=", "__utils__", "[", "'zfs.has_feature_flags'", "]", "(", ")...
Provide grains for zfs/zpool
[ "Provide", "grains", "for", "zfs", "/", "zpool" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/grains/zfs.py#L76-L86
train
saltstack/salt
salt/runners/network.py
wollist
def wollist(maclist, bcast='255.255.255.255', destport=9): ''' Send a "Magic Packet" to wake up a list of Minions. This list must contain one MAC hardware address per line CLI Example: .. code-block:: bash salt-run network.wollist '/path/to/maclist' salt-run network.wollist '/path...
python
def wollist(maclist, bcast='255.255.255.255', destport=9): ''' Send a "Magic Packet" to wake up a list of Minions. This list must contain one MAC hardware address per line CLI Example: .. code-block:: bash salt-run network.wollist '/path/to/maclist' salt-run network.wollist '/path...
[ "def", "wollist", "(", "maclist", ",", "bcast", "=", "'255.255.255.255'", ",", "destport", "=", "9", ")", ":", "ret", "=", "[", "]", "try", ":", "with", "salt", ".", "utils", ".", "files", ".", "fopen", "(", "maclist", ",", "'r'", ")", "as", "ifile...
Send a "Magic Packet" to wake up a list of Minions. This list must contain one MAC hardware address per line CLI Example: .. code-block:: bash salt-run network.wollist '/path/to/maclist' salt-run network.wollist '/path/to/maclist' 255.255.255.255 7 salt-run network.wollist '/path/...
[ "Send", "a", "Magic", "Packet", "to", "wake", "up", "a", "list", "of", "Minions", ".", "This", "list", "must", "contain", "one", "MAC", "hardware", "address", "per", "line" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/network.py#L19-L43
train
saltstack/salt
salt/runners/network.py
wol
def wol(mac, bcast='255.255.255.255', destport=9): ''' Send a "Magic Packet" to wake up a Minion CLI Example: .. code-block:: bash salt-run network.wol 08-00-27-13-69-77 salt-run network.wol 080027136977 255.255.255.255 7 salt-run network.wol 08:00:27:13:69:77 255.255.255.255 ...
python
def wol(mac, bcast='255.255.255.255', destport=9): ''' Send a "Magic Packet" to wake up a Minion CLI Example: .. code-block:: bash salt-run network.wol 08-00-27-13-69-77 salt-run network.wol 080027136977 255.255.255.255 7 salt-run network.wol 08:00:27:13:69:77 255.255.255.255 ...
[ "def", "wol", "(", "mac", ",", "bcast", "=", "'255.255.255.255'", ",", "destport", "=", "9", ")", ":", "dest", "=", "salt", ".", "utils", ".", "network", ".", "mac_str_to_bytes", "(", "mac", ")", "sock", "=", "socket", ".", "socket", "(", "socket", "...
Send a "Magic Packet" to wake up a Minion CLI Example: .. code-block:: bash salt-run network.wol 08-00-27-13-69-77 salt-run network.wol 080027136977 255.255.255.255 7 salt-run network.wol 08:00:27:13:69:77 255.255.255.255 7
[ "Send", "a", "Magic", "Packet", "to", "wake", "up", "a", "Minion" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/network.py#L46-L62
train
saltstack/salt
salt/runners/network.py
wolmatch
def wolmatch(tgt, tgt_type='glob', bcast='255.255.255.255', destport=9): ''' Send a "Magic Packet" to wake up Minions that are matched in the grains cache CLI Example: .. code-block:: bash salt-run network.wolmatch minion_id salt-run network.wolmatch 192.168.0.0/16 tgt_type='ipcidr' b...
python
def wolmatch(tgt, tgt_type='glob', bcast='255.255.255.255', destport=9): ''' Send a "Magic Packet" to wake up Minions that are matched in the grains cache CLI Example: .. code-block:: bash salt-run network.wolmatch minion_id salt-run network.wolmatch 192.168.0.0/16 tgt_type='ipcidr' b...
[ "def", "wolmatch", "(", "tgt", ",", "tgt_type", "=", "'glob'", ",", "bcast", "=", "'255.255.255.255'", ",", "destport", "=", "9", ")", ":", "ret", "=", "[", "]", "minions", "=", "__salt__", "[", "'cache.grains'", "]", "(", "tgt", ",", "tgt_type", ")", ...
Send a "Magic Packet" to wake up Minions that are matched in the grains cache CLI Example: .. code-block:: bash salt-run network.wolmatch minion_id salt-run network.wolmatch 192.168.0.0/16 tgt_type='ipcidr' bcast=255.255.255.255 destport=7
[ "Send", "a", "Magic", "Packet", "to", "wake", "up", "Minions", "that", "are", "matched", "in", "the", "grains", "cache" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/runners/network.py#L65-L86
train
saltstack/salt
salt/utils/memcached.py
get_conn
def get_conn(opts, profile=None, host=None, port=None): ''' Return a conn object for accessing memcached ''' if not (host and port): opts_pillar = opts.get('pillar', {}) opts_master = opts_pillar.get('master', {}) opts_merged = {} opts_merged.update(opts_master) ...
python
def get_conn(opts, profile=None, host=None, port=None): ''' Return a conn object for accessing memcached ''' if not (host and port): opts_pillar = opts.get('pillar', {}) opts_master = opts_pillar.get('master', {}) opts_merged = {} opts_merged.update(opts_master) ...
[ "def", "get_conn", "(", "opts", ",", "profile", "=", "None", ",", "host", "=", "None", ",", "port", "=", "None", ")", ":", "if", "not", "(", "host", "and", "port", ")", ":", "opts_pillar", "=", "opts", ".", "get", "(", "'pillar'", ",", "{", "}", ...
Return a conn object for accessing memcached
[ "Return", "a", "conn", "object", "for", "accessing", "memcached" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/memcached.py#L77-L107
train
saltstack/salt
salt/utils/memcached.py
set_
def set_(conn, key, value, time=DEFAULT_TIME, min_compress_len=DEFAULT_MIN_COMPRESS_LEN): ''' Set a key on the memcached server, overwriting the value if it exists. ''' if not isinstance(time, integer_types): raise SaltInvocationError('\'time\' must be an inte...
python
def set_(conn, key, value, time=DEFAULT_TIME, min_compress_len=DEFAULT_MIN_COMPRESS_LEN): ''' Set a key on the memcached server, overwriting the value if it exists. ''' if not isinstance(time, integer_types): raise SaltInvocationError('\'time\' must be an inte...
[ "def", "set_", "(", "conn", ",", "key", ",", "value", ",", "time", "=", "DEFAULT_TIME", ",", "min_compress_len", "=", "DEFAULT_MIN_COMPRESS_LEN", ")", ":", "if", "not", "isinstance", "(", "time", ",", "integer_types", ")", ":", "raise", "SaltInvocationError", ...
Set a key on the memcached server, overwriting the value if it exists.
[ "Set", "a", "key", "on", "the", "memcached", "server", "overwriting", "the", "value", "if", "it", "exists", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/utils/memcached.py#L123-L136
train
saltstack/salt
salt/modules/glassfish.py
_get_auth
def _get_auth(username, password): ''' Returns the HTTP auth header ''' if username and password: return requests.auth.HTTPBasicAuth(username, password) else: return None
python
def _get_auth(username, password): ''' Returns the HTTP auth header ''' if username and password: return requests.auth.HTTPBasicAuth(username, password) else: return None
[ "def", "_get_auth", "(", "username", ",", "password", ")", ":", "if", "username", "and", "password", ":", "return", "requests", ".", "auth", ".", "HTTPBasicAuth", "(", "username", ",", "password", ")", "else", ":", "return", "None" ]
Returns the HTTP auth header
[ "Returns", "the", "HTTP", "auth", "header" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/glassfish.py#L51-L58
train
saltstack/salt
salt/modules/glassfish.py
_get_url
def _get_url(ssl, url, port, path): ''' Returns the URL of the endpoint ''' if ssl: return 'https://{0}:{1}/management/domain/{2}'.format(url, port, path) else: return 'http://{0}:{1}/management/domain/{2}'.format(url, port, path)
python
def _get_url(ssl, url, port, path): ''' Returns the URL of the endpoint ''' if ssl: return 'https://{0}:{1}/management/domain/{2}'.format(url, port, path) else: return 'http://{0}:{1}/management/domain/{2}'.format(url, port, path)
[ "def", "_get_url", "(", "ssl", ",", "url", ",", "port", ",", "path", ")", ":", "if", "ssl", ":", "return", "'https://{0}:{1}/management/domain/{2}'", ".", "format", "(", "url", ",", "port", ",", "path", ")", "else", ":", "return", "'http://{0}:{1}/management...
Returns the URL of the endpoint
[ "Returns", "the", "URL", "of", "the", "endpoint" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/glassfish.py#L61-L68
train
saltstack/salt
salt/modules/glassfish.py
_clean_data
def _clean_data(data): ''' Removes SaltStack params from **kwargs ''' for key in list(data): if key.startswith('__pub'): del data[key] return data
python
def _clean_data(data): ''' Removes SaltStack params from **kwargs ''' for key in list(data): if key.startswith('__pub'): del data[key] return data
[ "def", "_clean_data", "(", "data", ")", ":", "for", "key", "in", "list", "(", "data", ")", ":", "if", "key", ".", "startswith", "(", "'__pub'", ")", ":", "del", "data", "[", "key", "]", "return", "data" ]
Removes SaltStack params from **kwargs
[ "Removes", "SaltStack", "params", "from", "**", "kwargs" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/glassfish.py#L78-L85
train
saltstack/salt
salt/modules/glassfish.py
_api_response
def _api_response(response): ''' Check response status code + success_code returned by glassfish ''' if response.status_code == 404: __context__['retcode'] = salt.defaults.exitcodes.SALT_BUILD_FAIL raise CommandExecutionError('Element doesn\'t exists') if response.status_code == 401:...
python
def _api_response(response): ''' Check response status code + success_code returned by glassfish ''' if response.status_code == 404: __context__['retcode'] = salt.defaults.exitcodes.SALT_BUILD_FAIL raise CommandExecutionError('Element doesn\'t exists') if response.status_code == 401:...
[ "def", "_api_response", "(", "response", ")", ":", "if", "response", ".", "status_code", "==", "404", ":", "__context__", "[", "'retcode'", "]", "=", "salt", ".", "defaults", ".", "exitcodes", ".", "SALT_BUILD_FAIL", "raise", "CommandExecutionError", "(", "'El...
Check response status code + success_code returned by glassfish
[ "Check", "response", "status", "code", "+", "success_code", "returned", "by", "glassfish" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/glassfish.py#L88-L109
train
saltstack/salt
salt/modules/glassfish.py
_api_get
def _api_get(path, server=None): ''' Do a GET request to the API ''' server = _get_server(server) response = requests.get( url=_get_url(server['ssl'], server['url'], server['port'], path), auth=_get_auth(server['user'], server['password']), headers=_get_headers(),...
python
def _api_get(path, server=None): ''' Do a GET request to the API ''' server = _get_server(server) response = requests.get( url=_get_url(server['ssl'], server['url'], server['port'], path), auth=_get_auth(server['user'], server['password']), headers=_get_headers(),...
[ "def", "_api_get", "(", "path", ",", "server", "=", "None", ")", ":", "server", "=", "_get_server", "(", "server", ")", "response", "=", "requests", ".", "get", "(", "url", "=", "_get_url", "(", "server", "[", "'ssl'", "]", ",", "server", "[", "'url'...
Do a GET request to the API
[ "Do", "a", "GET", "request", "to", "the", "API" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/glassfish.py#L112-L123
train
saltstack/salt
salt/modules/glassfish.py
_api_post
def _api_post(path, data, server=None): ''' Do a POST request to the API ''' server = _get_server(server) response = requests.post( url=_get_url(server['ssl'], server['url'], server['port'], path), auth=_get_auth(server['user'], server['password']), headers=_get_h...
python
def _api_post(path, data, server=None): ''' Do a POST request to the API ''' server = _get_server(server) response = requests.post( url=_get_url(server['ssl'], server['url'], server['port'], path), auth=_get_auth(server['user'], server['password']), headers=_get_h...
[ "def", "_api_post", "(", "path", ",", "data", ",", "server", "=", "None", ")", ":", "server", "=", "_get_server", "(", "server", ")", "response", "=", "requests", ".", "post", "(", "url", "=", "_get_url", "(", "server", "[", "'ssl'", "]", ",", "serve...
Do a POST request to the API
[ "Do", "a", "POST", "request", "to", "the", "API" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/glassfish.py#L126-L138
train
saltstack/salt
salt/modules/glassfish.py
_api_delete
def _api_delete(path, data, server=None): ''' Do a DELETE request to the API ''' server = _get_server(server) response = requests.delete( url=_get_url(server['ssl'], server['url'], server['port'], path), auth=_get_auth(server['user'], server['password']), headers=...
python
def _api_delete(path, data, server=None): ''' Do a DELETE request to the API ''' server = _get_server(server) response = requests.delete( url=_get_url(server['ssl'], server['url'], server['port'], path), auth=_get_auth(server['user'], server['password']), headers=...
[ "def", "_api_delete", "(", "path", ",", "data", ",", "server", "=", "None", ")", ":", "server", "=", "_get_server", "(", "server", ")", "response", "=", "requests", ".", "delete", "(", "url", "=", "_get_url", "(", "server", "[", "'ssl'", "]", ",", "s...
Do a DELETE request to the API
[ "Do", "a", "DELETE", "request", "to", "the", "API" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/glassfish.py#L141-L153
train
saltstack/salt
salt/modules/glassfish.py
_enum_elements
def _enum_elements(name, server=None): ''' Enum elements ''' elements = [] data = _api_get(name, server) if any(data['extraProperties']['childResources']): for element in data['extraProperties']['childResources']: elements.append(element) return elements return N...
python
def _enum_elements(name, server=None): ''' Enum elements ''' elements = [] data = _api_get(name, server) if any(data['extraProperties']['childResources']): for element in data['extraProperties']['childResources']: elements.append(element) return elements return N...
[ "def", "_enum_elements", "(", "name", ",", "server", "=", "None", ")", ":", "elements", "=", "[", "]", "data", "=", "_api_get", "(", "name", ",", "server", ")", "if", "any", "(", "data", "[", "'extraProperties'", "]", "[", "'childResources'", "]", ")",...
Enum elements
[ "Enum", "elements" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/glassfish.py#L157-L168
train
saltstack/salt
salt/modules/glassfish.py
_get_element_properties
def _get_element_properties(name, element_type, server=None): ''' Get an element's properties ''' properties = {} data = _api_get('{0}/{1}/property'.format(element_type, name), server) # Get properties into a dict if any(data['extraProperties']['properties']): for element in data['e...
python
def _get_element_properties(name, element_type, server=None): ''' Get an element's properties ''' properties = {} data = _api_get('{0}/{1}/property'.format(element_type, name), server) # Get properties into a dict if any(data['extraProperties']['properties']): for element in data['e...
[ "def", "_get_element_properties", "(", "name", ",", "element_type", ",", "server", "=", "None", ")", ":", "properties", "=", "{", "}", "data", "=", "_api_get", "(", "'{0}/{1}/property'", ".", "format", "(", "element_type", ",", "name", ")", ",", "server", ...
Get an element's properties
[ "Get", "an", "element", "s", "properties" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/glassfish.py#L171-L183
train
saltstack/salt
salt/modules/glassfish.py
_get_element
def _get_element(name, element_type, server=None, with_properties=True): ''' Get an element with or without properties ''' element = {} name = quote(name, safe='') data = _api_get('{0}/{1}'.format(element_type, name), server) # Format data, get properties if asked, and return the whole thin...
python
def _get_element(name, element_type, server=None, with_properties=True): ''' Get an element with or without properties ''' element = {} name = quote(name, safe='') data = _api_get('{0}/{1}'.format(element_type, name), server) # Format data, get properties if asked, and return the whole thin...
[ "def", "_get_element", "(", "name", ",", "element_type", ",", "server", "=", "None", ",", "with_properties", "=", "True", ")", ":", "element", "=", "{", "}", "name", "=", "quote", "(", "name", ",", "safe", "=", "''", ")", "data", "=", "_api_get", "("...
Get an element with or without properties
[ "Get", "an", "element", "with", "or", "without", "properties" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/glassfish.py#L186-L201
train
saltstack/salt
salt/modules/glassfish.py
_create_element
def _create_element(name, element_type, data, server=None): ''' Create a new element ''' # Define property and id from name and properties + remove SaltStack parameters if 'properties' in data: data['property'] = '' for key, value in data['properties'].items(): if not dat...
python
def _create_element(name, element_type, data, server=None): ''' Create a new element ''' # Define property and id from name and properties + remove SaltStack parameters if 'properties' in data: data['property'] = '' for key, value in data['properties'].items(): if not dat...
[ "def", "_create_element", "(", "name", ",", "element_type", ",", "data", ",", "server", "=", "None", ")", ":", "# Define property and id from name and properties + remove SaltStack parameters", "if", "'properties'", "in", "data", ":", "data", "[", "'property'", "]", "...
Create a new element
[ "Create", "a", "new", "element" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/glassfish.py#L204-L220
train
saltstack/salt
salt/modules/glassfish.py
_update_element
def _update_element(name, element_type, data, server=None): ''' Update an element, including it's properties ''' # Urlencode the name (names may have slashes) name = quote(name, safe='') # Update properties first if 'properties' in data: properties = [] for key, value in dat...
python
def _update_element(name, element_type, data, server=None): ''' Update an element, including it's properties ''' # Urlencode the name (names may have slashes) name = quote(name, safe='') # Update properties first if 'properties' in data: properties = [] for key, value in dat...
[ "def", "_update_element", "(", "name", ",", "element_type", ",", "data", ",", "server", "=", "None", ")", ":", "# Urlencode the name (names may have slashes)", "name", "=", "quote", "(", "name", ",", "safe", "=", "''", ")", "# Update properties first", "if", "'p...
Update an element, including it's properties
[ "Update", "an", "element", "including", "it", "s", "properties" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/glassfish.py#L223-L252
train
saltstack/salt
salt/modules/glassfish.py
_delete_element
def _delete_element(name, element_type, data, server=None): ''' Delete an element ''' _api_delete('{0}/{1}'.format(element_type, quote(name, safe='')), data, server) return name
python
def _delete_element(name, element_type, data, server=None): ''' Delete an element ''' _api_delete('{0}/{1}'.format(element_type, quote(name, safe='')), data, server) return name
[ "def", "_delete_element", "(", "name", ",", "element_type", ",", "data", ",", "server", "=", "None", ")", ":", "_api_delete", "(", "'{0}/{1}'", ".", "format", "(", "element_type", ",", "quote", "(", "name", ",", "safe", "=", "''", ")", ")", ",", "data"...
Delete an element
[ "Delete", "an", "element" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/glassfish.py#L255-L260
train
saltstack/salt
salt/modules/glassfish.py
create_connector_c_pool
def create_connector_c_pool(name, server=None, **kwargs): ''' Create a connection pool ''' defaults = { 'connectionDefinitionName': 'javax.jms.ConnectionFactory', 'resourceAdapterName': 'jmsra', 'associateWithThread': False, 'connectionCreationRetryAttempts': 0, '...
python
def create_connector_c_pool(name, server=None, **kwargs): ''' Create a connection pool ''' defaults = { 'connectionDefinitionName': 'javax.jms.ConnectionFactory', 'resourceAdapterName': 'jmsra', 'associateWithThread': False, 'connectionCreationRetryAttempts': 0, '...
[ "def", "create_connector_c_pool", "(", "name", ",", "server", "=", "None", ",", "*", "*", "kwargs", ")", ":", "defaults", "=", "{", "'connectionDefinitionName'", ":", "'javax.jms.ConnectionFactory'", ",", "'resourceAdapterName'", ":", "'jmsra'", ",", "'associateWith...
Create a connection pool
[ "Create", "a", "connection", "pool" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/glassfish.py#L278-L322
train