INSTRUCTION
stringlengths
1
8.43k
RESPONSE
stringlengths
75
104k
Upgrade packages
def upgrade(): ''' "Upgrade" packages ''' DETAILS = _load_state() pkgs = uptodate() DETAILS['packages'] = pkgs _save_state(DETAILS) return pkgs
Call the REST endpoint to see if the packages on the server are up to date.
def uptodate(): ''' Call the REST endpoint to see if the packages on the "server" are up to date. ''' DETAILS = _load_state() for p in DETAILS['packages']: version_float = float(DETAILS['packages'][p]) version_float = version_float + 1.0 DETAILS['packages'][p] = six.text_type...
Remove a package on the REST server
def package_remove(name): ''' Remove a "package" on the REST server ''' DETAILS = _load_state() DETAILS['packages'].pop(name) _save_state(DETAILS) return DETAILS['packages']
For this proxy shutdown is a no - op
def shutdown(opts): ''' For this proxy shutdown is a no-op ''' log.debug('dummy proxy shutdown() called...') DETAILS = _load_state() if 'filename' in DETAILS: os.unlink(DETAILS['filename'])
Opens archive.: return:
def open(self): ''' Opens archive. :return: ''' if self.__arch is not None: raise salt.exceptions.SaltException('Archive already opened.') self.__arch = tarfile.TarFile.bz2open(self.archive_path, 'w')
Closes the archive.: return:
def close(self): ''' Closes the archive. :return: ''' if self.__arch is None: raise salt.exceptions.SaltException('Archive already closed') self._flush_content() self.__arch.close() self.__arch = None
Flush content to the archive: return:
def _flush_content(self): ''' Flush content to the archive :return: ''' if self.__current_section is not None: buff = BytesIO() buff._dirty = False for action_return in self.__current_section: for title, ret_data in action_retur...
Start a new section.: param name:: return:
def add(self, name): ''' Start a new section. :param name: :return: ''' if self.__current_section: self._flush_content() self.discard_current(name)
Use salt outputter to printout content.
def _printout(self, data, output): ''' Use salt outputter to printout content. :return: ''' opts = {'extension_modules': '', 'color': False} try: printout = salt.output.get_printout(output, opts)(data) if printout is not None: retu...
Add a data to the current opened section.: return:
def write(self, title, data, output=None): ''' Add a data to the current opened section. :return: ''' if not isinstance(data, (dict, list, tuple)): data = {'raw-content': str(data)} output = output or self.__default_outputter if output != 'null': ...
Add a static file on the file system.
def link(self, title, path): ''' Add a static file on the file system. :param title: :param path: :return: ''' # The filehandler needs to be explicitly passed here, so PyLint needs to accept that. # pylint: disable=W8470 if not isinstance(path, fi...
Setup function configuration.
def _setup_fun_config(self, fun_conf): ''' Setup function configuration. :param conf: :return: ''' conf = copy.deepcopy(self.config) conf['file_client'] = 'local' conf['fun'] = '' conf['arg'] = [] conf['kwarg'] = {} conf['cache_job...
Get & setup runner.
def _get_runner(self, conf): ''' Get & setup runner. :param conf: :return: ''' conf = self._setup_fun_config(copy.deepcopy(conf)) if not getattr(self, '_runner', None): self._runner = salt.cli.support.localrunner.LocalRunner(conf) else: ...
Get & setup caller from the factory.
def _get_caller(self, conf): ''' Get & setup caller from the factory. :param conf: :return: ''' conf = self._setup_fun_config(copy.deepcopy(conf)) if not getattr(self, '_caller', None): self._caller = salt.cli.caller.Caller.factory(conf) else:...
Execute local call
def _local_call(self, call_conf): ''' Execute local call ''' try: ret = self._get_caller(call_conf).call() except SystemExit: ret = 'Data is not available at this moment' self.out.error(ret) except Exception as ex: ret = 'Un...
Execute local runner
def _local_run(self, run_conf): ''' Execute local runner :param run_conf: :return: ''' try: ret = self._get_runner(run_conf).run() except SystemExit: ret = 'Runner is not available at this moment' self.out.error(ret) ex...
Call internal function.
def _internal_function_call(self, call_conf): ''' Call internal function. :param call_conf: :return: ''' def stub(*args, **kwargs): message = 'Function {} is not available'.format(call_conf['fun']) self.out.error(message) log.debug( ...
Parse action and turn into a calling point.: param action_meta:: return:
def _get_action(self, action_meta): ''' Parse action and turn into a calling point. :param action_meta: :return: ''' conf = { 'fun': list(action_meta.keys())[0], 'arg': [], 'kwargs': {}, } if not len(conf['fun'].split('....
Dumps current running pillars configuration etc.: return:
def collect_internal_data(self): ''' Dumps current running pillars, configuration etc. :return: ''' section = 'configuration' self.out.put(section) self.collector.add(section) self.out.put('Saving config', indent=2) self.collector.write('General Co...
Extracts return data from the results.
def _extract_return(self, data): ''' Extracts return data from the results. :param data: :return: ''' if isinstance(data, dict): data = data.get('return', data) return data
Collects master system data.: return:
def collect_local_data(self, profile=None, profile_source=None): ''' Collects master system data. :return: ''' def call(func, *args, **kwargs): ''' Call wrapper for templates :param func: :return: ''' return ...
Get action type.: param action:: return:
def _get_action_type(self, action): ''' Get action type. :param action: :return: ''' action_name = next(iter(action or {'': None})) if ':' not in action_name: action_name = '{}:{}'.format(self.CALL_TYPE, action_name) return action_name.split('...
Cleanup if crash/ exception: return:
def _cleanup(self): ''' Cleanup if crash/exception :return: ''' if (hasattr(self, 'config') and self.config.get('support_archive') and os.path.exists(self.config['support_archive'])): self.out.warning('Terminated earlier, cleaning up') ...
Check if archive exists or not. If exists and -- force was not specified bail out. Otherwise remove it and move on.
def _check_existing_archive(self): ''' Check if archive exists or not. If exists and --force was not specified, bail out. Otherwise remove it and move on. :return: ''' if os.path.exists(self.config['support_archive']): if self.config['support_archive_force_ov...
Run the SPM command
def run(self, args): ''' Run the SPM command ''' command = args[0] try: if command == 'install': self._install(args) elif command == 'local': self._local(args) elif command == 'repo': self._repo(a...
Process local commands
def _list(self, args): ''' Process local commands ''' args.pop(0) command = args[0] if command == 'packages': self._list_packages(args) elif command == 'files': self._list_files(args) elif command == 'repos': self._repo_...
Process local commands
def _local(self, args): ''' Process local commands ''' args.pop(0) command = args[0] if command == 'install': self._local_install(args) elif command == 'files': self._local_list_files(args) elif command == 'info': self._...
Process repo commands
def _repo(self, args): ''' Process repo commands ''' args.pop(0) command = args[0] if command == 'list': self._repo_list(args) elif command == 'packages': self._repo_packages(args) elif command == 'search': self._repo_pa...
List packages for one or more configured repos
def _repo_packages(self, args, search=False): ''' List packages for one or more configured repos ''' packages = [] repo_metadata = self._get_repo_metadata() for repo in repo_metadata: for pkg in repo_metadata[repo]['packages']: if args[1] in pk...
List configured repos
def _repo_list(self, args): ''' List configured repos This can be called either as a ``repo`` command or a ``list`` command ''' repo_metadata = self._get_repo_metadata() for repo in repo_metadata: self.ui.status(repo)
Install a package from a repo
def _install(self, args): ''' Install a package from a repo ''' if len(args) < 2: raise SPMInvocationError('A package must be specified') caller_opts = self.opts.copy() caller_opts['file_client'] = 'local' self.caller = salt.client.Caller(mopts=caller...
Install a package from a file
def _local_install(self, args, pkg_name=None): ''' Install a package from a file ''' if len(args) < 2: raise SPMInvocationError('A package file must be specified') self._install(args)
Starting with one package check all packages for dependencies
def _check_all_deps(self, pkg_name=None, pkg_file=None, formula_def=None): ''' Starting with one package, check all packages for dependencies ''' if pkg_file and not os.path.exists(pkg_file): raise SPMInvocationError('Package file {0} not found'.format(pkg_file)) sel...
Install one individual package
def _install_indv_pkg(self, pkg_name, pkg_file): ''' Install one individual package ''' self.ui.status('... installing {0}'.format(pkg_name)) formula_tar = tarfile.open(pkg_file, 'r:bz2') formula_ref = formula_tar.extractfile('{0}/FORMULA'.format(pkg_name)) formul...
Return a list of packages which need to be installed to resolve all dependencies
def _resolve_deps(self, formula_def): ''' Return a list of packages which need to be installed, to resolve all dependencies ''' pkg_info = self.pkgdb['{0}.info'.format(self.db_prov)](formula_def['name']) if not isinstance(pkg_info, dict): pkg_info = {} ...
Traverse through all repo files and apply the functionality provided in the callback to them
def _traverse_repos(self, callback, repo_name=None): ''' Traverse through all repo files and apply the functionality provided in the callback to them ''' repo_files = [] if os.path.exists(self.opts['spm_repos_config']): repo_files.append(self.opts['spm_repos_c...
Download files via http
def _query_http(self, dl_path, repo_info): ''' Download files via http ''' query = None response = None try: if 'username' in repo_info: try: if 'password' in repo_info: query = http.query( ...
Connect to all repos and download metadata
def _download_repo_metadata(self, args): ''' Connect to all repos and download metadata ''' cache = salt.cache.Cache(self.opts, self.opts['spm_cache_dir']) def _update_metadata(repo, repo_info): dl_path = '{0}/SPM-METADATA'.format(repo_info['url']) if dl_...
Return cached repo metadata
def _get_repo_metadata(self): ''' Return cached repo metadata ''' cache = salt.cache.Cache(self.opts, self.opts['spm_cache_dir']) metadata = {} def _read_metadata(repo, repo_info): if cache.updated('.', repo) is None: log.warning('Updating rep...
Scan a directory and create an SPM - METADATA file which describes all of the SPM files in that directory.
def _create_repo(self, args): ''' Scan a directory and create an SPM-METADATA file which describes all of the SPM files in that directory. ''' if len(args) < 2: raise SPMInvocationError('A path to a directory must be specified') if args[1] == '.': ...
Remove a package
def _remove(self, args): ''' Remove a package ''' if len(args) < 2: raise SPMInvocationError('A package must be specified') packages = args[1:] msg = 'Removing packages:\n\t{0}'.format('\n\t'.join(packages)) if not self.opts['assume_yes']: ...
Display verbose information
def _verbose(self, msg, level=log.debug): ''' Display verbose information ''' if self.opts.get('verbose', False) is True: self.ui.status(msg) level(msg)
List info for a package file
def _local_info(self, args): ''' List info for a package file ''' if len(args) < 2: raise SPMInvocationError('A package filename must be specified') pkg_file = args[1] if not os.path.exists(pkg_file): raise SPMInvocationError('Package file {0} no...
List info for a package
def _info(self, args): ''' List info for a package ''' if len(args) < 2: raise SPMInvocationError('A package must be specified') package = args[1] pkg_info = self._pkgdb_fun('info', package, self.db_conn) if pkg_info is None: raise SPMPac...
Get package info
def _get_info(self, formula_def): ''' Get package info ''' fields = ( 'name', 'os', 'os_family', 'release', 'version', 'dependencies', 'os_dependencies', 'os_family_dependencies', ...
List files for a package file
def _local_list_files(self, args): ''' List files for a package file ''' if len(args) < 2: raise SPMInvocationError('A package filename must be specified') pkg_file = args[1] if not os.path.exists(pkg_file): raise SPMPackageError('Package file {0}...
List files for an installed package
def _list_packages(self, args): ''' List files for an installed package ''' packages = self._pkgdb_fun('list_packages', self.db_conn) for package in packages: if self.opts['verbose']: status_msg = ','.join(package) else: sta...
List files for an installed package
def _list_files(self, args): ''' List files for an installed package ''' if len(args) < 2: raise SPMInvocationError('A package name must be specified') package = args[-1] files = self._pkgdb_fun('list_files', package, self.db_conn) if files is None: ...
Build a package
def _build(self, args): ''' Build a package ''' if len(args) < 2: raise SPMInvocationError('A path to a formula must be specified') self.abspath = args[1].rstrip('/') comps = self.abspath.split('/') self.relpath = comps[-1] formula_path = '{0...
Exclude based on opts
def _exclude(self, member): ''' Exclude based on opts ''' if isinstance(member, string_types): return None for item in self.opts['spm_build_exclude']: if member.name.startswith('{0}/{1}'.format(self.formula_conf['name'], item)): return Non...
Render a [ pre|post ] _local_state or [ pre|post ] _tgt_state script
def _render(self, data, formula_def): ''' Render a [pre|post]_local_state or [pre|post]_tgt_state script ''' # FORMULA can contain a renderer option renderer = formula_def.get('renderer', self.opts.get('renderer', 'jinja|yaml')) rend = salt.loader.render(self.opts, {}) ...
Pre - process incoming queue attributes before setting them
def _preprocess_attributes(attributes): ''' Pre-process incoming queue attributes before setting them ''' if isinstance(attributes, six.string_types): attributes = salt.utils.json.loads(attributes) def stringified(val): # Some attributes take full json policy documents, but they tak...
Check to see if a queue exists.
def exists(name, region=None, key=None, keyid=None, profile=None): ''' Check to see if a queue exists. CLI Example: .. code-block:: bash salt myminion boto_sqs.exists myqueue region=us-east-1 ''' conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile) try: ...
Create an SQS queue.
def create( name, attributes=None, region=None, key=None, keyid=None, profile=None, ): ''' Create an SQS queue. CLI Example: .. code-block:: bash salt myminion boto_sqs.create myqueue region=us-east-1 ''' conn = _get_conn(region=region, key=key, keyid=keyid, pr...
Delete an SQS queue.
def delete(name, region=None, key=None, keyid=None, profile=None): ''' Delete an SQS queue. CLI Example: .. code-block:: bash salt myminion boto_sqs.delete myqueue region=us-east-1 ''' conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile) try: url = conn....
Return a list of the names of all visible queues.
def list_(prefix='', region=None, key=None, keyid=None, profile=None): ''' Return a list of the names of all visible queues. .. versionadded:: 2016.11.0 CLI Example: .. code-block:: bash salt myminion boto_sqs.list region=us-east-1 ''' conn = _get_conn(region=region, key=key, key...
Return attributes currently set on an SQS queue.
def get_attributes(name, region=None, key=None, keyid=None, profile=None): ''' Return attributes currently set on an SQS queue. CLI Example: .. code-block:: bash salt myminion boto_sqs.get_attributes myqueue ''' conn = _get_conn(region=region, key=key, keyid=keyid, profile=profile) ...
Set attributes on an SQS queue.
def set_attributes( name, attributes, region=None, key=None, keyid=None, profile=None, ): ''' Set attributes on an SQS queue. CLI Example: .. code-block:: bash salt myminion boto_sqs.set_attributes myqueue '{ReceiveMessageWaitTimeSeconds: 20}' region=us-east-1 ''' ...
Call the necessary functions in order to execute the state. For the moment this only calls the net. load_template function from the: mod: Network - related basic features execution module <salt. modules. napalm_network > but this may change in time.
def _update_config(template_name, template_source=None, template_hash=None, template_hash_name=None, template_user='root', template_group='root', template_mode='755', template_attrs='----...
.. versionadded:: 2019. 2. 0
def replace_pattern(name, pattern, repl, count=0, flags=8, bufsize=1, append_if_not_found=False, prepend_if_not_found=False, not_found_content=None, ...
.. versionadded:: 2019. 2. 0
def saved(name, source='running', user=None, group=None, mode=None, attrs=None, makedirs=False, dir_mode=None, replace=True, backup='', show_changes=True, create=True, tmp_dir='', tmp_ext=''...
Manages the configuration on network devices.
def managed(name, template_name=None, template_source=None, template_hash=None, template_hash_name=None, saltenv='base', template_engine='jinja', skip_verify=False, context=None, defaults=None, test=F...
.. versionadded:: 2019. 2. 0
def commit_cancelled(name): ''' .. versionadded:: 2019.2.0 Cancel a commit scheduled to be executed via the ``commit_in`` and ``commit_at`` arguments from the :py:func:`net.load_template <salt.modules.napalm_network.load_template>` or :py:func:`net.load_config <salt.modules.napalm_network.load_...
.. versionadded:: 2019. 2. 0
def commit_confirmed(name): ''' .. versionadded:: 2019.2.0 Confirm a commit scheduled to be reverted via the ``revert_in`` and ``revert_at`` arguments from the :mod:`net.load_template <salt.modules.napalm_network.load_template>` or :mod:`net.load_config <salt.modules.napalm_network.load_config>...
Serialize Python data to a Python string representation ( via pprint. format )
def serialize(obj, **options): ''' Serialize Python data to a Python string representation (via pprint.format) :param obj: the data structure to serialize :param options: options given to pprint.format ''' #round-trip this through JSON to avoid OrderedDict types # there's probably a more p...
Required. Can be used to initialize the server connection.
def init(opts): ''' Required. Can be used to initialize the server connection. ''' try: DETAILS['server'] = SSHConnection(host=__opts__['proxy']['host'], username=__opts__['proxy']['username'], password=__opt...
Get the grains from the proxied device
def grains(): ''' Get the grains from the proxied device ''' if not DETAILS.get('grains_cache', {}): cmd = 'info' # Send the command to execute out, err = DETAILS['server'].sendline(cmd) # "scrape" the output and return the right fields as a dict DETAILS['grain...
Required. Ping the device on the other end of the connection
def ping(): ''' Required. Ping the device on the other end of the connection ''' try: out, err = DETAILS['server'].sendline('help') return True except TerminalException as e: log.error(e) return False
Extract json from out.
def parse(out): ''' Extract json from out. Parameter out: Type string. The data returned by the ssh command. ''' jsonret = [] in_json = False for ln_ in out.split('\n'): if '{' in ln_: in_json = True if in_json: jsonret.append(ln_) ...
Install a package on the ssh server
def package_install(name, **kwargs): ''' Install a "package" on the ssh server ''' cmd = 'pkg_install ' + name if kwargs.get('version', False): cmd += ' ' + kwargs['version'] # Send the command to execute out, err = DETAILS['server'].sendline(cmd) # "scrape" the output and retu...
Remove a package on the ssh server
def package_remove(name): ''' Remove a "package" on the ssh server ''' cmd = 'pkg_remove ' + name # Send the command to execute out, err = DETAILS['server'].sendline(cmd) # "scrape" the output and return the right fields as a dict return parse(out)
Start a service on the ssh server
def service_start(name): ''' Start a "service" on the ssh server .. versionadded:: 2015.8.2 ''' cmd = 'start ' + name # Send the command to execute out, err = DETAILS['server'].sendline(cmd) # "scrape" the output and return the right fields as a dict return parse(out)
Stop a service on the ssh server
def service_stop(name): ''' Stop a "service" on the ssh server .. versionadded:: 2015.8.2 ''' cmd = 'stop ' + name # Send the command to execute out, err = DETAILS['server'].sendline(cmd) # "scrape" the output and return the right fields as a dict return parse(out)
Restart a service on the ssh server
def service_restart(name): ''' Restart a "service" on the ssh server .. versionadded:: 2015.8.2 ''' cmd = 'restart ' + name # Send the command to execute out, err = DETAILS['server'].sendline(cmd) # "scrape" the output and return the right fields as a dict return parse(out)
Execute a command against jboss instance through the CLI interface.
def run_command(jboss_config, command, fail_on_error=True): ''' Execute a command against jboss instance through the CLI interface. jboss_config Configuration dictionary with properties specified above. command Command to execute against jboss instance fail_on_error (default=T...
Execute an operation against jboss instance through the CLI interface.
def run_operation(jboss_config, operation, fail_on_error=True, retries=1): ''' Execute an operation against jboss instance through the CLI interface. jboss_config Configuration dictionary with properties specified above. operation An operation to execute against jboss instance ...
Delete a generic Elasticache resource.
def _delete_resource(name, name_param, desc, res_type, wait=0, status_param=None, status_gone='deleted', region=None, key=None, keyid=None, profile=None, **args): ''' Delete a generic Elasticache resource. ''' try: wait = int(wait) except Exception: ...
Return details about all ( or just one ) Elasticache cache clusters.
def describe_cache_clusters(name=None, conn=None, region=None, key=None, keyid=None, profile=None, **args): ''' Return details about all (or just one) Elasticache cache clusters. Example: .. code-block:: bash salt myminion boto3_elasticache.describe_cache_clusters ...
Check to see if a cache cluster exists.
def cache_cluster_exists(name, conn=None, region=None, key=None, keyid=None, profile=None): ''' Check to see if a cache cluster exists. Example: .. code-block:: bash salt myminion boto3_elasticache.cache_cluster_exists myelasticache ''' return bool(describe_cache_clusters(name=name, c...
Create a cache cluster.
def create_cache_cluster(name, wait=600, security_groups=None, region=None, key=None, keyid=None, profile=None, **args): ''' Create a cache cluster. Example: .. code-block:: bash salt myminion boto3_elasticache.create_cache_cluster name=myCacheCluster \ ...
Check to see if a replication group exists.
def replication_group_exists(name, region=None, key=None, keyid=None, profile=None): ''' Check to see if a replication group exists. Example: .. code-block:: bash salt myminion boto3_elasticache.replication_group_exists myelasticache ''' return bool(describe_replication_groups(name=na...
Delete an ElastiCache replication group optionally taking a snapshot first.
def delete_replication_group(name, wait=600, region=None, key=None, keyid=None, profile=None, **args): ''' Delete an ElastiCache replication group, optionally taking a snapshot first. Example: .. code-block:: bash salt myminion boto3_elasticache.delete_replication_group my-replication-group ...
Check to see if an ElastiCache subnet group exists.
def cache_subnet_group_exists(name, region=None, key=None, keyid=None, profile=None): ''' Check to see if an ElastiCache subnet group exists. Example: .. code-block:: bash salt myminion boto3_elasticache.cache_subnet_group_exists my-subnet-group ''' return bool(describe_cache_subnet_g...
Return a list of all cache subnet group names
def list_cache_subnet_groups(region=None, key=None, keyid=None, profile=None): ''' Return a list of all cache subnet group names Example: .. code-block:: bash salt myminion boto3_elasticache.list_cache_subnet_groups region=us-east-1 ''' return [g['CacheSubnetGroupName'] for g in ...
Create an ElastiCache subnet group
def create_cache_subnet_group(name, subnets=None, region=None, key=None, keyid=None, profile=None, **args): ''' Create an ElastiCache subnet group Example: .. code-block:: bash salt myminion boto3_elasticache.create_cache_subnet_group name=my-subnet-group \ ...
Check to see if an ElastiCache security group exists.
def cache_security_group_exists(name, region=None, key=None, keyid=None, profile=None): ''' Check to see if an ElastiCache security group exists. Example: .. code-block:: bash salt myminion boto3_elasticache.cache_security_group_exists mysecuritygroup ''' return bool(describe_cache_se...
Create a cache security group.
def create_cache_security_group(name, region=None, key=None, keyid=None, profile=None, **args): ''' Create a cache security group. Example: .. code-block:: bash salt myminion boto3_elasticache.create_cache_security_group mycachesecgrp Description='My Cache Security Group' ''' return _...
Delete a cache security group.
def delete_cache_security_group(name, region=None, key=None, keyid=None, profile=None, **args): ''' Delete a cache security group. Example: .. code-block:: bash salt myminion boto3_elasticache.delete_cache_security_group myelasticachesg ''' return _delete_resource(name, name_param='Ca...
Authorize network ingress from an ec2 security group to a cache security group.
def authorize_cache_security_group_ingress(name, region=None, key=None, keyid=None, profile=None, **args): ''' Authorize network ingress from an ec2 security group to a cache security group. Example: .. code-block:: bash salt myminion boto3_elasticache.authorize_cache_security_group_ingress \...
Return details about all ( or just one ) Elasticache cache clusters.
def describe_cache_parameter_groups(name=None, conn=None, region=None, key=None, keyid=None, profile=None): ''' Return details about all (or just one) Elasticache cache clusters. Example: .. code-block:: bash salt myminion boto3_elasticache.describe_cache_p...
Returns the detailed parameter list for a particular cache parameter group.
def describe_cache_parameters(name=None, conn=None, region=None, key=None, keyid=None, profile=None, **args): ''' Returns the detailed parameter list for a particular cache parameter group. name The name of a specific cache parameter group to return details for. C...
Update a cache parameter group in place.
def modify_cache_parameter_group(name, region=None, key=None, keyid=None, profile=None, **args): ''' Update a cache parameter group in place. Note that due to a design limitation in AWS, this function is not atomic -- a maximum of 20 params may be modified in one underl...
Check if portname is valid and whether or not the directory exists in the ports tree.
def _check_portname(name): ''' Check if portname is valid and whether or not the directory exists in the ports tree. ''' if not isinstance(name, string_types) or '/' not in name: raise SaltInvocationError( 'Invalid port name \'{0}\' (category required)'.format(name) ) ...
Retrieve the path to the dir containing OPTIONS file for a given port
def _options_dir(name): ''' Retrieve the path to the dir containing OPTIONS file for a given port ''' _check_portname(name) _root = '/var/db/ports' # New path: /var/db/ports/category_portname new_dir = os.path.join(_root, name.replace('/', '_')) # Old path: /var/db/ports/portname ol...
Returns True/ False based on whether or not the options file for the specified port exists.
def _options_file_exists(name): ''' Returns True/False based on whether or not the options file for the specified port exists. ''' return os.path.isfile(os.path.join(_options_dir(name), 'options'))
Writes a new OPTIONS file
def _write_options(name, configuration): ''' Writes a new OPTIONS file ''' _check_portname(name) pkg = next(iter(configuration)) conf_ptr = configuration[pkg] dirname = _options_dir(name) if not os.path.isdir(dirname): try: os.makedirs(dirname) except OSErro...
Fix Salt s yaml - ification of on/ off and otherwise normalize the on/ off values to be used in writing the options file
def _normalize(val): ''' Fix Salt's yaml-ification of on/off, and otherwise normalize the on/off values to be used in writing the options file ''' if isinstance(val, bool): return 'on' if val else 'off' return six.text_type(val).lower()
Install a port from the ports tree. Installs using BATCH = yes for non - interactive building. To set config options for a given port use: mod: ports. config <salt. modules. freebsdports. config >.
def install(name, clean=True): ''' Install a port from the ports tree. Installs using ``BATCH=yes`` for non-interactive building. To set config options for a given port, use :mod:`ports.config <salt.modules.freebsdports.config>`. clean : True If ``True``, cleans after installation. Equivale...
De - install a port.
def deinstall(name): ''' De-install a port. CLI Example: .. code-block:: bash salt '*' ports.deinstall security/nmap ''' portpath = _check_portname(name) old = __salt__['pkg.list_pkgs']() result = __salt__['cmd.run_all']( ['make', 'deinstall', 'BATCH=yes'], cwd...
Clear the cached options for the specified port ; run a make rmconfig
def rmconfig(name): ''' Clear the cached options for the specified port; run a ``make rmconfig`` name The name of the port to clear CLI Example: .. code-block:: bash salt '*' ports.rmconfig security/nmap ''' portpath = _check_portname(name) return __salt__['cmd.run'](...