INSTRUCTION
stringlengths
1
8.43k
RESPONSE
stringlengths
75
104k
Replace labels dict by a new one
def _set_labels(node, apiserver_url, labels): '''Replace labels dict by a new one''' # Prepare URL url = "{0}/api/v1/nodes/{1}".format(apiserver_url, node) # Prepare data data = [{"op": "replace", "path": "/metadata/labels", "value": labels}] # Make request ret = _kpatch(url, data) if re...
.. versionadded:: 2016. 3. 0
def get_labels(node=None, apiserver_url=None): ''' .. versionadded:: 2016.3.0 Get labels from the current node CLI Example: .. code-block:: bash salt '*' k8s.get_labels salt '*' k8s.get_labels kube-node.cluster.local http://kube-master.cluster.local ''' # Get salt minion...
.. versionadded:: 2016. 3. 0
def label_present(name, value, node=None, apiserver_url=None): ''' .. versionadded:: 2016.3.0 Set label to the current node CLI Example: .. code-block:: bash salt '*' k8s.label_present hw/disktype ssd salt '*' k8s.label_present hw/disktype ssd kube-node.cluster.local http://kube...
.. versionadded:: 2016. 3. 0
def label_absent(name, node=None, apiserver_url=None): ''' .. versionadded:: 2016.3.0 Delete label to the current node CLI Example: .. code-block:: bash salt '*' k8s.label_absent hw/disktype salt '*' k8s.label_absent hw/disktype kube-node.cluster.local http://kube-master.cluster....
Get namespace is namespace is defined otherwise return all namespaces
def _get_namespaces(apiserver_url, name=""): '''Get namespace is namespace is defined otherwise return all namespaces''' # Prepare URL url = "{0}/api/v1/namespaces/{1}".format(apiserver_url, name) # Make request ret = http.query(url) if ret.get("body"): return salt.utils.json.loads(ret.g...
create namespace on the defined k8s cluster
def _create_namespace(namespace, apiserver_url): ''' create namespace on the defined k8s cluster ''' # Prepare URL url = "{0}/api/v1/namespaces".format(apiserver_url) # Prepare data data = { "kind": "Namespace", "apiVersion": "v1", "metadata": { "name": namespace,...
.. versionadded:: 2016. 3. 0
def create_namespace(name, apiserver_url=None): ''' .. versionadded:: 2016.3.0 Create kubernetes namespace from the name, similar to the functionality added to kubectl since v.1.2.0: .. code-block:: bash kubectl create namespaces namespace-name CLI Example: .. code-block:: bash ...
.. versionadded:: 2016. 3. 0
def get_namespaces(namespace="", apiserver_url=None): ''' .. versionadded:: 2016.3.0 Get one or all kubernetes namespaces. If namespace parameter is omitted, all namespaces will be returned back to user, similar to following kubectl example: .. code-block:: bash kubectl get namespaces -o...
Replace secrets data by a new one
def _update_secret(namespace, name, data, apiserver_url): '''Replace secrets data by a new one''' # Prepare URL url = "{0}/api/v1/namespaces/{1}/secrets/{2}".format(apiserver_url, namespace, name) # Prepare data data = [{"op": "replace", "path...
create namespace on the defined k8s cluster
def _create_secret(namespace, name, data, apiserver_url): ''' create namespace on the defined k8s cluster ''' # Prepare URL url = "{0}/api/v1/namespaces/{1}/secrets".format(apiserver_url, namespace) # Prepare data request = { "apiVersion": "v1", "kind": "Secret", "metadata": ...
Get k8s namespaces
def get_secrets(namespace, name="", apiserver_url=None, decode=False, brief=False): ''' Get k8s namespaces CLI Example: .. code-block:: bash salt '*' k8s.get_secrets namespace_name salt '*' k8s.get_secrets namespace_name secret_name http://kube-master.cluster.local ''' # Try ...
.. versionadded:: 2016. 3. 0
def update_secret(namespace, name, sources, apiserver_url=None, force=True, saltenv='base'): ''' .. versionadded:: 2016.3.0 alias to k8s.create_secret with update=true CLI Example: .. code-block:: bash salt '*' k8s.update_secret namespace_name secret_name sources [apiserver_url] [force=t...
.. versionadded:: 2016. 3. 0
def create_secret(namespace, name, sources, apiserver_url=None, force=False, update=False, saltenv='base'): ''' .. versionadded:: 2016.3.0 Create k8s secrets in the defined namespace from the list of files CLI Example: .. code-block:: bash salt '*' k8s.create_secret namespace_name secret...
.. versionadded:: 2016. 3. 0
def delete_secret(namespace, name, apiserver_url=None, force=True): ''' .. versionadded:: 2016.3.0 Delete kubernetes secret in the defined namespace. Namespace is the mandatory parameter as well as name. CLI Example: .. code-block:: bash salt '*' k8s.delete_secret namespace_name secret_n...
Return the correct pillar driver based on the file_client option
def get_pillar(opts, grains, minion_id, saltenv=None, ext=None, funcs=None, pillar_override=None, pillarenv=None, extra_minion_data=None): ''' Return the correct pillar driver based on the file_client option ''' file_client = opts['file_client'] if opts.get('master_type') == 'disable'...
Return the correct pillar driver based on the file_client option
def get_async_pillar(opts, grains, minion_id, saltenv=None, ext=None, funcs=None, pillar_override=None, pillarenv=None, extra_minion_data=None): ''' Return the correct pillar driver based on the file_client option ''' file_client = opts['file_client'] if opt...
Returns the extra data from the minion s opts dict ( the config file ).
def get_ext_pillar_extra_minion_data(self, opts): ''' Returns the extra data from the minion's opts dict (the config file). This data will be passed to external pillar functions. ''' def get_subconfig(opts_key): ''' Returns a dict containing the opts key ...
Return a future which will contain the pillar data from the master
def compile_pillar(self): ''' Return a future which will contain the pillar data from the master ''' load = {'id': self.minion_id, 'grains': self.grains, 'saltenv': self.opts['saltenv'], 'pillarenv': self.opts['pillarenv'], ...
Return the pillar data from the master
def compile_pillar(self): ''' Return the pillar data from the master ''' load = {'id': self.minion_id, 'grains': self.grains, 'saltenv': self.opts['saltenv'], 'pillarenv': self.opts['pillarenv'], 'pillar_override': self.pill...
In the event of a cache miss we need to incur the overhead of caching a new pillar.
def fetch_pillar(self): ''' In the event of a cache miss, we need to incur the overhead of caching a new pillar. ''' log.debug('Pillar cache getting external pillar with ext: %s', self.ext) fresh_pillar = Pillar(self.opts, self.grains, ...
Compile pillar and set it to the cache if not found.
def compile_pillar(self, *args, **kwargs): # Will likely just be pillar_dirs ''' Compile pillar and set it to the cache, if not found. :param args: :param kwargs: :return: ''' log.debug('Scanning pillar cache for information about minion %s and pillarenv %s', se...
Check to see if the on demand external pillar is allowed
def __valid_on_demand_ext_pillar(self, opts): ''' Check to see if the on demand external pillar is allowed ''' if not isinstance(self.ext, dict): log.error( 'On-demand pillar %s is not formatted as a dictionary', self.ext ) ...
Gather the lists of available sls data from the master
def __gather_avail(self): ''' Gather the lists of available sls data from the master ''' avail = {} for saltenv in self._get_envs(): avail[saltenv] = self.client.list_states(saltenv) return avail
The options need to be altered to conform to the file client
def __gen_opts(self, opts_in, grains, saltenv=None, ext=None, pillarenv=None): ''' The options need to be altered to conform to the file client ''' opts = copy.deepcopy(opts_in) opts['file_client'] = 'local' if not grains: opts['grains'] = {} else: ...
Pull the file server environments out of the master options
def _get_envs(self): ''' Pull the file server environments out of the master options ''' envs = set(['base']) if 'pillar_roots' in self.opts: envs.update(list(self.opts['pillar_roots'])) return envs
Gather the top files
def get_tops(self): ''' Gather the top files ''' tops = collections.defaultdict(list) include = collections.defaultdict(list) done = collections.defaultdict(list) errors = [] # Gather initial top files try: saltenvs = set() ...
Cleanly merge the top files
def merge_tops(self, tops): ''' Cleanly merge the top files ''' top = collections.defaultdict(OrderedDict) orders = collections.defaultdict(OrderedDict) for ctops in six.itervalues(tops): for ctop in ctops: for saltenv, targets in six.iteritems...
Returns the sorted high data from the merged top files
def sort_top_targets(self, top, orders): ''' Returns the sorted high data from the merged top files ''' sorted_top = collections.defaultdict(OrderedDict) # pylint: disable=cell-var-from-loop for saltenv, targets in six.iteritems(top): sorted_targets = sorted(t...
Returns the high data derived from the top file
def get_top(self): ''' Returns the high data derived from the top file ''' tops, errors = self.get_tops() try: merged_tops = self.merge_tops(tops) except TypeError as err: merged_tops = OrderedDict() errors.append('Error encountered whi...
Search through the top high data for matches and return the states that this minion needs to execute.
def top_matches(self, top): ''' Search through the top high data for matches and return the states that this minion needs to execute. Returns: {'saltenv': ['state1', 'state2', ...]} ''' matches = {} for saltenv, body in six.iteritems(top): if ...
Collect a single pillar sls file and render it
def render_pstate(self, sls, saltenv, mods, defaults=None): ''' Collect a single pillar sls file and render it ''' if defaults is None: defaults = {} err = '' errors = [] state_data = self.client.get_state(sls, saltenv) fn_ = state_data.get('de...
Extract the sls pillar files from the matches and render them into the pillar
def render_pillar(self, matches, errors=None): ''' Extract the sls pillar files from the matches and render them into the pillar ''' pillar = copy.copy(self.pillar_override) if errors is None: errors = [] for saltenv, pstates in six.iteritems(matches):...
Builds actual pillar data structure and updates the pillar variable
def _external_pillar_data(self, pillar, val, key): ''' Builds actual pillar data structure and updates the ``pillar`` variable ''' ext = None args = salt.utils.args.get_function_argspec(self.ext_pillars[key]).args if isinstance(val, dict): if ('extra_minion_d...
Render the external pillar data
def ext_pillar(self, pillar, errors=None): ''' Render the external pillar data ''' if errors is None: errors = [] try: # Make sure that on-demand git_pillar is fetched before we try to # compile the pillar data. git_pillar will fetch a remote w...
Render the pillar data and return
def compile_pillar(self, ext=True): ''' Render the pillar data and return ''' top, top_errors = self.get_top() if ext: if self.opts.get('ext_pillar_first', False): self.opts['pillar'], errors = self.ext_pillar(self.pillar_override) self...
Decrypt the specified pillar dictionary items if configured to do so
def decrypt_pillar(self, pillar): ''' Decrypt the specified pillar dictionary items, if configured to do so ''' errors = [] if self.opts.get('decrypt_pillar'): decrypt_pillar = self.opts['decrypt_pillar'] if not isinstance(decrypt_pillar, dict): ...
Ensure that the Pki module is loaded and convert to and extract data from Json as needed.
def _cmd_run(cmd, as_json=False): ''' Ensure that the Pki module is loaded, and convert to and extract data from Json as needed. ''' cmd_full = ['Import-Module -Name PKI; '] if as_json: cmd_full.append(r'ConvertTo-Json -Compress -Depth 4 -InputObject ' r'@({0})'....
Ensure that the certificate path as determind from user input is valid.
def _validate_cert_path(name): ''' Ensure that the certificate path, as determind from user input, is valid. ''' cmd = r"Test-Path -Path '{0}'".format(name) if not ast.literal_eval(_cmd_run(cmd=cmd)): raise SaltInvocationError(r"Invalid path specified: {0}".format(name))
Ensure that the certificate format as determind from user input is valid.
def _validate_cert_format(name): ''' Ensure that the certificate format, as determind from user input, is valid. ''' cert_formats = ['cer', 'pfx'] if name not in cert_formats: message = ("Invalid certificate format '{0}' specified. Valid formats:" ' {1}').format(name, cer...
Get the certificate location contexts and their corresponding stores.
def get_stores(): ''' Get the certificate location contexts and their corresponding stores. :return: A dictionary of the certificate location contexts and stores. :rtype: dict CLI Example: .. code-block:: bash salt '*' win_pki.get_stores ''' ret = dict() cmd = r"Get-Child...
Get the available certificates in the given store.
def get_certs(context=_DEFAULT_CONTEXT, store=_DEFAULT_STORE): ''' Get the available certificates in the given store. :param str context: The name of the certificate store location context. :param str store: The name of the certificate store. :return: A dictionary of the certificate thumbprints an...
Get the details of the certificate file.
def get_cert_file(name, cert_format=_DEFAULT_FORMAT, password=''): ''' Get the details of the certificate file. :param str name: The filesystem path of the certificate file. :param str cert_format: The certificate format. Specify 'cer' for X.509, or 'pfx' for PKCS #12. :param str password: ...
Import the certificate file into the given certificate store.
def import_cert(name, cert_format=_DEFAULT_FORMAT, context=_DEFAULT_CONTEXT, store=_DEFAULT_STORE, exportable=True, password='', saltenv='base'): ''' Import the certificate file into the given certificate store. ...
Export the certificate to a file from the given certificate store.
def export_cert(name, thumbprint, cert_format=_DEFAULT_FORMAT, context=_DEFAULT_CONTEXT, store=_DEFAULT_STORE, password=''): ''' Export the certificate to a file from the given certificate store. :param str name: The destinatio...
Remove the certificate from the given certificate store.
def remove_cert(thumbprint, context=_DEFAULT_CONTEXT, store=_DEFAULT_STORE): ''' Remove the certificate from the given certificate store. :param str thumbprint: The thumbprint value of the target certificate. :param str context: The name of the certificate store location context. :param str store: ...
Ensure that the named schema is present in the database.
def present(dbname, name, owner=None, user=None, db_user=None, db_password=None, db_host=None, db_port=None): ''' Ensure that the named schema is present in the database. dbname The database's name will work on name The name of the schema to manage ...
Return a memcache server object
def _get_serv(ret): ''' Return a memcache server object ''' _options = _get_options(ret) host = _options.get('host') port = _options.get('port') log.debug('memcache server: %s:%s', host, port) if not host or not port: log.error('Host or port not defined in salt config') ...
Return data to a memcache data store
def returner(ret): ''' Return data to a memcache data store ''' serv = _get_serv(ret) minion = ret['id'] jid = ret['jid'] fun = ret['fun'] rets = salt.utils.json.dumps(ret) serv.set('{0}:{1}'.format(jid, minion), rets) # cache for get_jid serv.set('{0}:{1}'.format(fun, minion), ...
Save the load to the specified jid
def save_load(jid, load, minions=None): ''' Save the load to the specified jid ''' serv = _get_serv(ret=None) serv.set(jid, salt.utils.json.dumps(load)) _append_list(serv, 'jids', jid)
Return a dict of the last function called for all minions
def get_fun(fun): ''' Return a dict of the last function called for all minions ''' serv = _get_serv(ret=None) minions = _get_list(serv, 'minions') returns = serv.get_multi(minions, key_prefix='{0}:'.format(fun)) # returns = {minion: return, minion: return, ...} ret = {} for minion, ...
Return a list of all job ids
def get_jids(): ''' Return a list of all job ids ''' serv = _get_serv(ret=None) jids = _get_list(serv, 'jids') loads = serv.get_multi(jids) # {jid: load, jid: load, ...} ret = {} for jid, load in six.iteritems(loads): ret[jid] = salt.utils.jid.format_jid_instance(jid, salt.utils...
Ensure the ELB exists.
def present(name, listeners, availability_zones=None, subnets=None, subnet_names=None, security_groups=None, scheme='internet-facing', health_check=None, attributes=None, attributes_from_pillar="boto_elb_attributes", cnames=None, alarms=None, alarms_from_pillar="boto_elb_...
Add EC2 instance ( s ) to an Elastic Load Balancer. Removing an instance from the instances list does not remove it from the ELB.
def register_instances(name, instances, region=None, key=None, keyid=None, profile=None): ''' Add EC2 instance(s) to an Elastic Load Balancer. Removing an instance from the ``instances`` list does not remove it from the ELB. name The name of the Elastic Load Balancer to a...
helper method for present. ensure that cloudwatch_alarms are set
def _alarms_present(name, alarms, alarms_from_pillar, region, key, keyid, profile): '''helper method for present. ensure that cloudwatch_alarms are set''' current = __salt__['config.option'](alarms_from_pillar, {}) if alarms: current = salt.utils.dictupdate.update(current, alarms) ret = {'name'...
helper method for present. ensure that ELB policies are set
def _policies_present(name, policies, policies_from_pillar, listeners, backends, region, key, keyid, profile): '''helper method for present. ensure that ELB policies are set''' if policies is None: policies = [] pillar_policies = __salt__['config.option'](policies_from_pillar, ...
Ensure an ELB does not exist
def absent(name, region=None, key=None, keyid=None, profile=None): ''' Ensure an ELB does not exist name name of the ELB ''' ret = {'name': name, 'result': True, 'comment': '', 'changes': {}} exists = __salt__['boto_elb.exists'](name, region, key, keyid, profile) if exists: ...
helper function to validate tags on elb
def _tags_present(name, tags, region, key, keyid, profile): ''' helper function to validate tags on elb ''' ret = {'result': True, 'comment': '', 'changes': {}} if tags: lb = __salt__['boto_elb.get_elb_config'](name, region, key, keyid, profile) tags_to_add = tags tags_to_up...
Return the object that is referenced by the specified proxy.
def get_reference(proxy): ''' Return the object that is referenced by the specified proxy. If the proxy has not been bound to a reference for the current thread, the behavior depends on th the ``fallback_to_shared`` flag that has been specified when creating the proxy. If the fl...
Set the reference to be used the current thread of execution.
def set_reference(proxy, new_reference): ''' Set the reference to be used the current thread of execution. After calling this function, the specified proxy will act like it was the referenced object. proxy: proxy object for which the reference shall be set. If the s...
Unwrap and return the object referenced by a proxy.
def unproxy(possible_proxy): ''' Unwrap and return the object referenced by a proxy. This function is very similar to :func:`get_reference`, but works for both proxies and regular objects. If the specified object is a proxy, its reference is extracted with ``get_reference`` and ...
Return a list of the new modules pass an lsmod dict before running modprobe and one after modprobe has run
def _new_mods(pre_mods, post_mods): ''' Return a list of the new modules, pass an lsmod dict before running modprobe and one after modprobe has run ''' pre = set() post = set() for mod in pre_mods: pre.add(mod['module']) for mod in post_mods: post.add(mod['module']) r...
Return a list of the new modules pass an lsmod dict before running modprobe and one after modprobe has run
def _rm_mods(pre_mods, post_mods): ''' Return a list of the new modules, pass an lsmod dict before running modprobe and one after modprobe has run ''' pre = set() post = set() for mod in pre_mods: pre.add(mod['module']) for mod in post_mods: post.add(mod['module']) re...
Add module to configuration file to make it persistent. If module is commented uncomment it.
def _set_persistent_module(mod): ''' Add module to configuration file to make it persistent. If module is commented uncomment it. ''' conf = _get_modules_conf() if not os.path.exists(conf): __salt__['file.touch'](conf) mod_name = _strip_module_name(mod) if not mod_name or mod_nam...
Remove module from configuration file. If comment is true only comment line where module is.
def _remove_persistent_module(mod, comment): ''' Remove module from configuration file. If comment is true only comment line where module is. ''' conf = _get_modules_conf() mod_name = _strip_module_name(mod) if not mod_name or mod_name not in mod_list(True): return set() escape_m...
Return a list of all available kernel modules
def available(): ''' Return a list of all available kernel modules CLI Example: .. code-block:: bash salt '*' kmod.available ''' ret = [] mod_dir = os.path.join('/lib/modules/', os.uname()[2]) built_in_file = os.path.join(mod_dir, 'modules.builtin') if os.path.exists(bui...
Return a list of the loaded module names
def mod_list(only_persist=False): ''' Return a list of the loaded module names only_persist Only return the list of loaded persistent modules CLI Example: .. code-block:: bash salt '*' kmod.mod_list ''' mods = set() if only_persist: conf = _get_modules_conf() ...
Load the specified kernel module
def load(mod, persist=False): ''' Load the specified kernel module mod Name of module to add persist Write module to /etc/modules to make it load on system reboot CLI Example: .. code-block:: bash salt '*' kmod.load kvm ''' pre_mods = lsmod() res = __salt...
Required. Can be used to initialize the server connection.
def init(opts=None): ''' Required. Can be used to initialize the server connection. ''' if opts is None: opts = __opts__ try: DETAILS[_worker_name()] = SSHConnection( host=opts['proxy']['host'], username=opts['proxy']['username'], password=opts...
Ping the device on the other end of the connection
def ping(): ''' Ping the device on the other end of the connection .. code-block: bash salt '*' onyx.cmd ping ''' if _worker_name() not in DETAILS: init() try: return DETAILS[_worker_name()].conn.isalive() except TerminalException as e: log.error(e) ...
Run command through switch s cli
def sendline(command): ''' Run command through switch's cli .. code-block: bash salt '*' onyx.cmd sendline 'show run | include "username admin password 7"' ''' if ping() is False: init() out, _ = DETAILS[_worker_name()].sendline(command) return out
Get grains for proxy minion
def grains(): ''' Get grains for proxy minion .. code-block: bash salt '*' onyx.cmd grains ''' if not DETAILS['grains_cache']: ret = system_info() log.debug(ret) DETAILS['grains_cache'].update(ret) return {'onyx': DETAILS['grains_cache']}
Get username line from switch
def get_user(username): ''' Get username line from switch .. code-block: bash salt '*' onyx.cmd get_user username=admin ''' try: enable() configure_terminal() cmd_out = sendline('show running-config | include "username {0} password 7"'.format(username)) cmd_...
Get roles that the username is assigned from switch
def get_roles(username): ''' Get roles that the username is assigned from switch .. code-block: bash salt '*' onyx.cmd get_roles username=admin ''' info = sendline('show user-account {0}'.format(username)) roles = re.search(r'^\s*roles:(.*)$', info, re.MULTILINE) if roles: ...
Remove user from switch
def remove_user(username): ''' Remove user from switch .. code-block:: bash salt '*' onyx.cmd remove_user username=daniel ''' try: sendline('config terminal') user_line = 'no username {0}'.format(username) ret = sendline(user_line) sendline('end') se...
Assign role to username
def set_role(username, role): ''' Assign role to username .. code-block:: bash salt '*' onyx.cmd set_role username=daniel role=vdc-admin ''' try: sendline('config terminal') role_line = 'username {0} role {1}'.format(username, role) ret = sendline(role_line) ...
Shortcut to run show run on switch
def show_run(): ''' Shortcut to run `show run` on switch .. code-block:: bash salt '*' onyx.cmd show_run ''' try: enable() configure_terminal() ret = sendline('show running-config') configure_terminal_exit() disable() except TerminalException as ...
Add one or more config lines to the switch running config
def add_config(lines): ''' Add one or more config lines to the switch running config .. code-block:: bash salt '*' onyx.cmd add_config 'snmp-server community TESTSTRINGHERE rw' .. note:: For more than one config added per command, lines should be a list. ''' if not isinstance(...
Delete one or more config lines to the switch running config
def delete_config(lines): ''' Delete one or more config lines to the switch running config .. code-block:: bash salt '*' onyx.cmd delete_config 'snmp-server community TESTSTRINGHERE group network-operator' .. note:: For more than one config deleted per command, lines should be a list....
Find all instances where the pattern is in the running command
def find(pattern): ''' Find all instances where the pattern is in the running command .. code-block:: bash salt '*' onyx.cmd find '^snmp-server.*$' .. note:: This uses the `re.MULTILINE` regex format for python, and runs the regex against the whole show_run output. ''' ...
Replace string or full line matches in switch s running config
def replace(old_value, new_value, full_match=False): ''' Replace string or full line matches in switch's running config If full_match is set to True, then the whole line will need to be matched as part of the old value. .. code-block:: bash salt '*' onyx.cmd replace 'TESTSTRINGHERE' 'NEWT...
Ensure that the named group is present with the specified privileges Please note that the user/ group notion in postgresql is just abstract we have roles where users can be seen as roles with the LOGIN privilege and groups the others.
def present(name, createdb=None, createroles=None, encrypted=None, superuser=None, inherit=None, login=None, replication=None, password=None, refresh_password=None, groups=None, user=None,...
Ensure that the named group is absent
def absent(name, user=None, maintenance_db=None, db_password=None, db_host=None, db_port=None, db_user=None): ''' Ensure that the named group is absent name The groupname of the group to remove user System user all opera...
Given a port number and protocol returns the port definition expected by docker - py. For TCP ports this is simply an integer for UDP ports this is ( port_num udp ).
def get_port_def(port_num, proto='tcp'): ''' Given a port number and protocol, returns the port definition expected by docker-py. For TCP ports this is simply an integer, for UDP ports this is (port_num, 'udp'). port_num can also be a string in the format 'port_num/udp'. If so, the "proto" argu...
Given a port number or range return a start and end to that range. Port ranges are defined as a string containing two numbers separated by a dash ( e. g. 4505 - 4506 ).
def get_port_range(port_def): ''' Given a port number or range, return a start and end to that range. Port ranges are defined as a string containing two numbers separated by a dash (e.g. '4505-4506'). A ValueError will be raised if bad input is provided. ''' if isinstance(port_def, six.inte...
Many arguments come in as a list of VAL1: VAL2 pairs but map to a list of dicts in the format { NAME1: VAL1 NAME2: VAL2 }. This function provides common code to handle these instances.
def map_vals(val, *names, **extra_opts): ''' Many arguments come in as a list of VAL1:VAL2 pairs, but map to a list of dicts in the format {NAME1: VAL1, NAME2: VAL2}. This function provides common code to handle these instances. ''' fill = extra_opts.pop('fill', NOTSET) expected_num_elements...
Input should either be a single string or a list of strings. This is used for the two args that deal with commands ( command and entrypoint ).
def translate_command(val): ''' Input should either be a single string, or a list of strings. This is used for the two args that deal with commands ("command" and "entrypoint"). ''' if isinstance(val, six.string_types): return val elif isinstance(val, list): for idx in range(len(...
These values can be expressed as an integer number of bytes or a string expression ( i. e. 100mb 1gb etc. ).
def translate_bytes(val): ''' These values can be expressed as an integer number of bytes, or a string expression (i.e. 100mb, 1gb, etc.). ''' try: val = int(val) except (TypeError, ValueError): if not isinstance(val, six.string_types): val = six.text_type(val) re...
On the CLI these are passed as multiple instances of a given CLI option. In Salt we accept these as a comma - delimited list but the API expects a Python list. This function accepts input and returns it back as a Python list of strings. If the input is a string which is a comma - separated list of items split that stri...
def translate_stringlist(val): ''' On the CLI, these are passed as multiple instances of a given CLI option. In Salt, we accept these as a comma-delimited list but the API expects a Python list. This function accepts input and returns it back as a Python list of strings. If the input is a string whi...
CLI input is a list of PATH: RATE pairs but the API expects a list of dictionaries in the format [ { Path: path Rate: rate } ]
def translate_device_rates(val, numeric_rate=True): ''' CLI input is a list of PATH:RATE pairs, but the API expects a list of dictionaries in the format [{'Path': path, 'Rate': rate}] ''' val = map_vals(val, 'Path', 'Rate') for idx in range(len(val)): try: is_abs = os.path.is...
CLI input is a list of key/ val pairs but the API expects a dictionary in the format { key: val }
def translate_key_val(val, delimiter='='): ''' CLI input is a list of key/val pairs, but the API expects a dictionary in the format {key: val} ''' if isinstance(val, dict): return val val = translate_stringlist(val) new_val = {} for item in val: try: lvalue, r...
Can either be a list of label names or a list of name = value pairs. The API can accept either a list of label names or a dictionary mapping names to values so the value we translate will be different depending on the input.
def translate_labels(val): ''' Can either be a list of label names, or a list of name=value pairs. The API can accept either a list of label names or a dictionary mapping names to values, so the value we translate will be different depending on the input. ''' if not isinstance(val, dict): ...
Checks if there is an open connection from the minion to the defined host on a specific port.
def check(name, port=None, **kwargs): ''' Checks if there is an open connection from the minion to the defined host on a specific port. name host name or ip address to test connection to port The port to test the connection on kwargs Additional parameters, parameters allowe...
Return a mode value that is predictable
def _refine_mode(mode): ''' Return a mode value that is predictable ''' mode = six.text_type(mode).lower() if any([mode.startswith('e'), mode == '1', mode == 'on']): return 'Enforcing' if any([mode.startswith('p'), mode == '0', mode == 'off...
Verifies the mode SELinux is running in can be set to enforcing permissive or disabled
def mode(name): ''' Verifies the mode SELinux is running in, can be set to enforcing, permissive, or disabled .. note:: A change to or from disabled mode requires a system reboot. You will need to perform this yourself. name The mode to run SELinux in, permissive, enforcing...
Set up an SELinux boolean
def boolean(name, value, persist=False): ''' Set up an SELinux boolean name The name of the boolean to set value The value to set on the boolean persist Defaults to False, set persist to true to make the boolean apply on a reboot ''' ret = {'name': name, ...
Enable/ Disable and optionally force a specific version for an SELinux module
def module(name, module_state='Enabled', version='any', **opts): ''' Enable/Disable and optionally force a specific version for an SELinux module name The name of the module to control module_state Should the module be enabled or disabled? version Defaults to no preference...
Installs custom SELinux module from given file
def module_install(name): ''' Installs custom SELinux module from given file name Path to file with module to install .. versionadded:: 2016.11.6 ''' ret = {'name': name, 'result': True, 'comment': '', 'changes': {}} if __salt__['selinux.install_sem...
Removes SELinux module
def module_remove(name): ''' Removes SELinux module name The name of the module to remove .. versionadded:: 2016.11.6 ''' ret = {'name': name, 'result': True, 'comment': '', 'changes': {}} modules = __salt__['selinux.list_semod']() if name not i...
.. versionadded:: 2017. 7. 0
def fcontext_policy_present(name, sel_type, filetype='a', sel_user=None, sel_level=None): ''' .. versionadded:: 2017.7.0 Makes sure a SELinux policy for a given filespec (name), filetype and SELinux context type is present. name filespec of the file or directory. Regex syntax is allowed. ...
.. versionadded:: 2017. 7. 0
def fcontext_policy_absent(name, filetype='a', sel_type=None, sel_user=None, sel_level=None): ''' .. versionadded:: 2017.7.0 Makes sure an SELinux file context policy for a given filespec (name), filetype and SELinux context type is absent. name filespec of the file or directory. Regex syn...