INSTRUCTION stringlengths 1 8.43k | RESPONSE stringlengths 75 104k |
|---|---|
Helper function that converts the utc offset string into number of minutes offset. Input is in form [ + - ] ?HHMM. Example valid inputs are + 0500 - 0300 and 0800. These would return - 300 180 480 respectively. | def _offset_to_min(utc_offset):
'''
Helper function that converts the utc offset string into number of minutes
offset. Input is in form "[+-]?HHMM". Example valid inputs are "+0500"
"-0300" and "0800". These would return -300, 180, 480 respectively.
'''
match = re.match(r"^([+-])?(\d\d)(\d\d)$",... |
Will return the current time adjusted using the input timezone offset. | def _get_offset_time(utc_offset):
'''
Will return the current time adjusted using the input timezone offset.
:rtype datetime:
'''
if utc_offset is not None:
minutes = _offset_to_min(utc_offset)
offset = timedelta(minutes=minutes)
offset_time = datetime.utcnow() + offset
... |
Set the system time. | def set_system_time(newtime, utc_offset=None):
'''
Set the system time.
:param str newtime:
The time to set. Can be any of the following formats.
- HH:MM:SS AM/PM
- HH:MM AM/PM
- HH:MM:SS (24 hour)
- HH:MM (24 hour)
Note that the salt command line parser par... |
Set the system date and time. Each argument is an element of the date but not required. If an element is not passed the current system value for that element will be used. For example if you don t pass the year the current system year will be used. ( Used by set_system_date and set_system_time ) | def set_system_date_time(years=None,
months=None,
days=None,
hours=None,
minutes=None,
seconds=None,
utc_offset=None):
'''
Set the system date and time. Each argu... |
Get PRETTY_HOSTNAME value stored in/ etc/ machine - info If this file doesn t exist or the variable doesn t exist return False. | def get_computer_desc():
'''
Get PRETTY_HOSTNAME value stored in /etc/machine-info
If this file doesn't exist or the variable doesn't exist
return False.
:return: Value of PRETTY_HOSTNAME if this does not exist False.
:rtype: str
CLI Example:
.. code-block:: bash
salt '*' sys... |
Set PRETTY_HOSTNAME value stored in/ etc/ machine - info This will create the file if it does not exist. If it is unable to create or modify this file returns False. | def set_computer_desc(desc):
'''
Set PRETTY_HOSTNAME value stored in /etc/machine-info
This will create the file if it does not exist. If
it is unable to create or modify this file returns False.
:param str desc: The computer description
:return: False on failure. True if successful.
CLI E... |
This function is used to remember that an event indicating that a reboot is required was witnessed. This function writes to a temporary filesystem so the event gets cleared upon reboot. | def set_reboot_required_witnessed():
'''
This function is used to remember that an event indicating that a reboot is
required was witnessed. This function writes to a temporary filesystem so
the event gets cleared upon reboot.
Returns:
bool: ``True`` if successful, otherwise ``False``
... |
Override this to handle the streams as they arrive | def handle_stream(self, stream):
'''
Override this to handle the streams as they arrive
:param IOStream stream: An IOStream for processing
See https://tornado.readthedocs.io/en/latest/iostream.html#tornado.iostream.IOStream
for additional details.
'''
@tornado.g... |
Routines to handle any cleanup before the instance shuts down. Sockets and filehandles should be closed explicitly to prevent leaks. | def close(self):
'''
Routines to handle any cleanup before the instance shuts down.
Sockets and filehandles should be closed explicitly, to prevent
leaks.
'''
if self._closing:
return
self._closing = True
if hasattr(self.sock, 'close'):
... |
Connect to the IPC socket | def connect(self, callback=None, timeout=None):
'''
Connect to the IPC socket
'''
if hasattr(self, '_connecting_future') and not self._connecting_future.done(): # pylint: disable=E0203
future = self._connecting_future # pylint: disable=E0203
else:
if has... |
Connect to a running IPCServer | def _connect(self, timeout=None):
'''
Connect to a running IPCServer
'''
if isinstance(self.socket_path, int):
sock_type = socket.AF_INET
sock_addr = ('127.0.0.1', self.socket_path)
else:
sock_type = socket.AF_UNIX
sock_addr = self.... |
Routines to handle any cleanup before the instance shuts down. Sockets and filehandles should be closed explicitly to prevent leaks. | def close(self):
'''
Routines to handle any cleanup before the instance shuts down.
Sockets and filehandles should be closed explicitly, to prevent
leaks.
'''
if self._closing:
return
if self._refcount > 1:
# Decrease refcount
... |
Send a message to an IPC socket | def send(self, msg, timeout=None, tries=None):
'''
Send a message to an IPC socket
If the socket is not currently connected, a connection will be established.
:param dict msg: The message to be sent
:param int timeout: Timeout when sending message (Currently unimplemented)
... |
Perform the work necessary to start up a Tornado IPC server | def start(self):
'''
Perform the work necessary to start up a Tornado IPC server
Blocks until socket is established
'''
# Start up the ioloop
log.trace('IPCMessagePublisher: binding to socket: %s', self.socket_path)
if isinstance(self.socket_path, int):
... |
Send message to all connected sockets | def publish(self, msg):
'''
Send message to all connected sockets
'''
if not self.streams:
return
pack = salt.transport.frame.frame_msg_ipc(msg, raw_body=True)
for stream in self.streams:
self.io_loop.spawn_callback(self._write, stream, pack) |
Routines to handle any cleanup before the instance shuts down. Sockets and filehandles should be closed explicitly to prevent leaks. | def close(self):
'''
Routines to handle any cleanup before the instance shuts down.
Sockets and filehandles should be closed explicitly, to prevent
leaks.
'''
if self._closing:
return
self._closing = True
for stream in self.streams:
... |
Read a message from an IPC socket | def read_sync(self, timeout=None):
'''
Read a message from an IPC socket
The socket must already be connected.
The associated IO Loop must NOT be running.
:param int timeout: Timeout when receiving message
:return: message data if successful. None if timed out. Will rais... |
Asynchronously read messages and invoke a callback when they are ready. | def read_async(self):
'''
Asynchronously read messages and invoke a callback when they are ready.
:param callback: A callback with the received data
'''
while not self.connected():
try:
yield self.connect(timeout=5)
except tornado.iostream... |
Routines to handle any cleanup before the instance shuts down. Sockets and filehandles should be closed explicitly to prevent leaks. | def close(self):
'''
Routines to handle any cleanup before the instance shuts down.
Sockets and filehandles should be closed explicitly, to prevent
leaks.
'''
if not self._closing:
IPCClient.close(self)
if self._closing:
# This will... |
List the jobs currently scheduled on the minion | def list_(show_all=False,
show_disabled=True,
where=None,
return_yaml=True):
'''
List the jobs currently scheduled on the minion
CLI Example:
.. code-block:: bash
salt '*' schedule.list
# Show all jobs including hidden internal jobs
salt '*' sche... |
List a Job only if its enabled | def is_enabled(name):
'''
List a Job only if its enabled
.. versionadded:: 2015.5.3
CLI Example:
.. code-block:: bash
salt '*' schedule.is_enabled name=job_name
'''
current_schedule = __salt__['schedule.list'](show_all=False, return_yaml=False)
if name in current_schedule:
... |
Purge all the jobs currently scheduled on the minion | def purge(**kwargs):
'''
Purge all the jobs currently scheduled on the minion
CLI Example:
.. code-block:: bash
salt '*' schedule.purge
'''
ret = {'comment': [],
'result': True}
for name in list_(show_all=True, return_yaml=False):
if name == 'enabled':
... |
Build a schedule job | def build_schedule_item(name, **kwargs):
'''
Build a schedule job
CLI Example:
.. code-block:: bash
salt '*' schedule.build_schedule_item job1 function='test.ping' seconds=3600
'''
ret = {'comment': [],
'result': True}
if not name:
ret['comment'] = 'Job name i... |
Add a job to the schedule | def add(name, **kwargs):
'''
Add a job to the schedule
CLI Example:
.. code-block:: bash
salt '*' schedule.add job1 function='test.ping' seconds=3600
# If function have some arguments, use job_args
salt '*' schedule.add job2 function='cmd.run' job_args="['date >> /tmp/date.log... |
Modify an existing job in the schedule | def modify(name, **kwargs):
'''
Modify an existing job in the schedule
CLI Example:
.. code-block:: bash
salt '*' schedule.modify job1 function='test.ping' seconds=3600
'''
ret = {'comment': '',
'changes': {},
'result': True}
time_conflict = False
for i... |
Run a scheduled job on the minion immediately | def run_job(name, force=False):
'''
Run a scheduled job on the minion immediately
CLI Example:
.. code-block:: bash
salt '*' schedule.run_job job1
salt '*' schedule.run_job job1 force=True
Force the job to run even if it is disabled.
'''
ret = {'comment': [],
... |
Enable a job in the minion s schedule | def enable_job(name, **kwargs):
'''
Enable a job in the minion's schedule
CLI Example:
.. code-block:: bash
salt '*' schedule.enable_job job1
'''
ret = {'comment': [],
'result': True}
if not name:
ret['comment'] = 'Job name is required.'
ret['result'] ... |
Save all scheduled jobs on the minion | def save(**kwargs):
'''
Save all scheduled jobs on the minion
CLI Example:
.. code-block:: bash
salt '*' schedule.save
'''
ret = {'comment': [],
'result': True}
if 'test' in kwargs and kwargs['test']:
ret['comment'] = 'Schedule would be saved.'
else:
... |
Reload saved scheduled jobs on the minion | def reload_():
'''
Reload saved scheduled jobs on the minion
CLI Example:
.. code-block:: bash
salt '*' schedule.reload
'''
ret = {'comment': [],
'result': True}
# If there a schedule defined in pillar, refresh it.
if 'schedule' in __pillar__:
out = __salt... |
Move scheduled job to another minion or minions. | def move(name, target, **kwargs):
'''
Move scheduled job to another minion or minions.
CLI Example:
.. code-block:: bash
salt '*' schedule.move jobname target
'''
ret = {'comment': [],
'result': True}
if not name:
ret['comment'] = 'Job name is required.'
... |
Postpone a job in the minion s schedule | def postpone_job(name,
current_time,
new_time,
**kwargs):
'''
Postpone a job in the minion's schedule
Current time and new time should be in date string format,
default value is %Y-%m-%dT%H:%M:%S.
.. versionadded:: 2018.3.0
CLI Example:
... |
Return True if this minion is a proxy minion. Leverages the fact that is_linux () and is_windows both return False for proxies. TODO: Need to extend this for proxies that might run on other Unices | def is_proxy():
'''
Return True if this minion is a proxy minion.
Leverages the fact that is_linux() and is_windows
both return False for proxies.
TODO: Need to extend this for proxies that might run on
other Unices
'''
import __main__ as main
# This is a hack. If a proxy minion is ... |
Function to return if host is SmartOS ( Illumos ) global zone or not | def is_smartos_globalzone():
'''
Function to return if host is SmartOS (Illumos) global zone or not
'''
if not is_smartos():
return False
else:
cmd = ['zonename']
try:
zonename = subprocess.Popen(
cmd, shell=False,
stdout=subprocess... |
Create an image for a specific platform. | def bootstrap(
platform,
root,
img_format='dir',
fs_format='ext2',
fs_opts=None,
arch=None,
flavor=None,
repo_url=None,
static_qemu=None,
img_size=None,
mount_dir=None,
pkg_cache=None,
pkgs=None,
exclude_pkgs... |
Make a partition and make it bootable | def _mkpart(root, fs_format, fs_opts, mount_dir):
'''
Make a partition, and make it bootable
.. versionadded:: Beryllium
'''
__salt__['partition.mklabel'](root, 'msdos')
loop1 = __salt__['cmd.run']('losetup -f')
log.debug('First loop device is %s', loop1)
__salt__['cmd.run']('losetup {0... |
Make a filesystem using the appropriate module | def _mkfs(root, fs_format, fs_opts=None):
'''
Make a filesystem using the appropriate module
.. versionadded:: Beryllium
'''
if fs_opts is None:
fs_opts = {}
if fs_format in ('ext2', 'ext3', 'ext4'):
__salt__['extfs.mkfs'](root, fs_format, **fs_opts)
elif fs_format in ('btr... |
If a pkg_cache directory is specified then use it to populate the disk image. | def _populate_cache(platform, pkg_cache, mount_dir):
'''
If a ``pkg_cache`` directory is specified, then use it to populate the
disk image.
'''
if not pkg_cache:
return
if not os.path.isdir(pkg_cache):
return
if platform == 'pacman':
cache_dir = '{0}/var/cache/pacman... |
Bootstrap an image using the yum tools | def _bootstrap_yum(
root,
pkg_confs='/etc/yum*',
pkgs=None,
exclude_pkgs=None,
epel_url=EPEL_URL,
):
'''
Bootstrap an image using the yum tools
root
The root of the image to install to. Will be created as a directory if
it does not exist. (e.x.: /... |
Bootstrap an image using the Debian tools | def _bootstrap_deb(
root,
arch,
flavor,
repo_url=None,
static_qemu=None,
pkgs=None,
exclude_pkgs=None,
):
'''
Bootstrap an image using the Debian tools
root
The root of the image to install to. Will be created as a directory if
it ... |
Bootstrap an image using the pacman tools | def _bootstrap_pacman(
root,
pkg_confs='/etc/pacman*',
img_format='dir',
pkgs=None,
exclude_pkgs=None,
):
'''
Bootstrap an image using the pacman tools
root
The root of the image to install to. Will be created as a directory if
it does not exist. ... |
Make the minimum number of nodes inside of/ dev/. Based on: | def _make_nodes(root):
'''
Make the minimum number of nodes inside of /dev/. Based on:
https://wiki.archlinux.org/index.php/Linux_Containers
'''
dirs = (
('{0}/etc'.format(root), 'root', 'root', '755'),
('{0}/dev'.format(root), 'root', 'root', '755'),
('{0}/proc'.format(root... |
Return which platforms are available | def avail_platforms():
'''
Return which platforms are available
CLI Example:
.. code-block:: bash
salt myminion genesis.avail_platforms
'''
ret = {}
for platform in CMD_MAP:
ret[platform] = True
for cmd in CMD_MAP[platform]:
if not salt.utils.path.which... |
Pack up a directory structure into a specific format | def pack(name, root, path=None, pack_format='tar', compress='bzip2'):
'''
Pack up a directory structure, into a specific format
CLI Examples:
.. code-block:: bash
salt myminion genesis.pack centos /root/centos
salt myminion genesis.pack centos /root/centos pack_format='tar'
'''
... |
Unpack an image into a directory structure | def unpack(name, dest=None, path=None, pack_format='tar', compress='bz2'):
'''
Unpack an image into a directory structure
CLI Example:
.. code-block:: bash
salt myminion genesis.unpack centos /root/centos
'''
if pack_format == 'tar':
_untar(name, dest, path, compress) |
Pack up image in a tar format | def _tar(name, root, path=None, compress='bzip2'):
'''
Pack up image in a tar format
'''
if path is None:
path = os.path.join(salt.syspaths.BASE_FILE_ROOTS_DIR, 'img')
if not __salt__['file.directory_exists'](path):
try:
__salt__['file.mkdir'](path)
except Excepti... |
Resolve compression flags | def _compress(compress):
'''
Resolve compression flags
'''
if compress in ('bz2', 'bzip2', 'j'):
compression = 'j'
ext = 'bz2'
elif compress in ('gz', 'gzip', 'z'):
compression = 'z'
ext = 'gz'
elif compress in ('xz', 'a', 'J'):
compression = 'J'
e... |
Recurse through a set of dependencies reported by ldd to find associated dependencies. | def ldd_deps(filename, ret=None):
'''
Recurse through a set of dependencies reported by ``ldd``, to find
associated dependencies.
Please note that this does not necessarily resolve all (non-package)
dependencies for a file; but it does help.
CLI Example:
salt myminion genesis.ldd_deps... |
Convert an installation file/ script to an SLS file. Currently supports kickstart preseed and autoyast. | def mksls(fmt, src, dst=None):
'''
Convert an installation file/script to an SLS file. Currently supports
``kickstart``, ``preseed``, and ``autoyast``.
CLI Examples:
salt <minion> genesis.mksls kickstart /path/to/kickstart.cfg
salt <minion> genesis.mksls kickstart /path/to/kickstart.cf... |
Execute the desired powershell command and ensure that it returns data in json format and load that into python | def _pshell(cmd, cwd=None, json_depth=2):
'''
Execute the desired powershell command and ensure that it returns data
in json format and load that into python
'''
if 'convertto-json' not in cmd.lower():
cmd = '{0} | ConvertTo-Json -Depth {1}'.format(cmd, json_depth)
log.debug('DSC: %s', c... |
List available modules in registered Powershell module repositories. | def avail_modules(desc=False):
'''
List available modules in registered Powershell module repositories.
:param desc: If ``True``, the verbose description will be returned.
:type desc: ``bool``
CLI Example:
.. code-block:: bash
salt 'win01' psget.avail_modules
salt 'win01' ps... |
List currently installed PSGet Modules on the system. | def list_modules(desc=False):
'''
List currently installed PSGet Modules on the system.
:param desc: If ``True``, the verbose description will be returned.
:type desc: ``bool``
CLI Example:
.. code-block:: bash
salt 'win01' psget.list_modules
salt 'win01' psget.list_modules ... |
Install a Powershell module from powershell gallery on the system. | def install(name, minimum_version=None, required_version=None, scope=None,
repository=None):
'''
Install a Powershell module from powershell gallery on the system.
:param name: Name of a Powershell module
:type name: ``str``
:param minimum_version: The maximum version to install, e.g.... |
Update a PowerShell module to a specific version or the newest | def update(name, maximum_version=None, required_version=None):
'''
Update a PowerShell module to a specific version, or the newest
:param name: Name of a Powershell module
:type name: ``str``
:param maximum_version: The maximum version to install, e.g. 1.23.2
:type maximum_version: ``str``
... |
Remove a Powershell DSC module from the system. | def remove(name):
'''
Remove a Powershell DSC module from the system.
:param name: Name of a Powershell DSC module
:type name: ``str``
CLI Example:
.. code-block:: bash
salt 'win01' psget.remove PowerPlan
'''
# Putting quotes around the parameter protects against command i... |
Register a PSGet repository on the local machine | def register_repository(name, location, installation_policy=None):
'''
Register a PSGet repository on the local machine
:param name: The name for the repository
:type name: ``str``
:param location: The URI for the repository
:type location: ``str``
:param installation_policy: The instal... |
Get the details of a local PSGet repository | def get_repository(name):
'''
Get the details of a local PSGet repository
:param name: Name of the repository
:type name: ``str``
CLI Example:
.. code-block:: bash
salt 'win01' psget.get_repository MyRepo
'''
# Putting quotes around the parameter protects against command i... |
.. versionchanged:: 2015. 8. 0 | def present(name,
running=None,
clone_from=None,
snapshot=False,
profile=None,
network_profile=None,
template=None,
options=None,
image=None,
config=None,
fstype=None,
size=None,
... |
Ensure a container is not present destroying it if present | def absent(name, stop=False, path=None):
'''
Ensure a container is not present, destroying it if present
name
Name of the container to destroy
stop
stop before destroying
default: false
.. versionadded:: 2015.5.2
path
path to the container parent
d... |
.. versionchanged:: 2015. 5. 0 The: mod: lxc. started <salt. states. lxc. started > state has been renamed to lxc. running | def running(name, restart=False, path=None):
'''
.. versionchanged:: 2015.5.0
The :mod:`lxc.started <salt.states.lxc.started>` state has been renamed
to ``lxc.running``
Ensure that a container is running
.. note::
This state does not enforce the existence of the named containe... |
Ensure that a container is stopped | def stopped(name, kill=False, path=None):
'''
Ensure that a container is stopped
.. note::
This state does not enforce the existence of the named container, it
just stops the container if it running or frozen. To ensure that the
named container exists, use :mod:`lxc.present
... |
.. warning:: | def edited_conf(name, lxc_conf=None, lxc_conf_unset=None):
'''
.. warning::
This state is unsuitable for setting parameters that appear more than
once in an LXC config file, or parameters which must appear in a
certain order (such as when configuring more than one network
interf... |
Generate the salt - thin tarball and print the location of the tarball Optional additional mods to include ( e. g. mako ) can be supplied as a comma delimited string. Permits forcing an overwrite of the output file as well. | def generate(extra_mods='', overwrite=False, so_mods='',
python2_bin='python2', python3_bin='python3', absonly=True,
compress='gzip'):
'''
Generate the salt-thin tarball and print the location of the tarball
Optional additional mods to include (e.g. mako) can be supplied as a comma... |
Generate the salt - thin tarball and print the location of the tarball Optional additional mods to include ( e. g. mako ) can be supplied as a comma delimited string. Permits forcing an overwrite of the output file as well. | def generate_min(extra_mods='', overwrite=False, so_mods='',
python2_bin='python2', python3_bin='python3'):
'''
Generate the salt-thin tarball and print the location of the tarball
Optional additional mods to include (e.g. mako) can be supplied as a comma
delimited string. Permits forcing ... |
REST authentication | def auth(username, password):
'''
REST authentication
'''
url = rest_auth_setup()
data = {'username': username, 'password': password}
# Post to the API endpoint. If 200 is returned then the result will be the ACLs
# for this user
result = salt.utils.http.query(url, method='POST', data... |
Ensure a user is present | def present(name, profile="github", **kwargs):
'''
Ensure a user is present
.. code-block:: yaml
ensure user test is present in github:
github.present:
- name: 'gitexample'
The following parameters are required:
name
This is the github handle of the us... |
Ensure a github user is absent | def absent(name, profile="github", **kwargs):
'''
Ensure a github user is absent
.. code-block:: yaml
ensure user test is absent in github:
github.absent:
- name: 'Example TestUser1'
- email: example@domain.com
- username: 'gitexample'
... |
Ensure a team is present | def team_present(
name,
description=None,
repo_names=None,
privacy='secret',
permission='pull',
members=None,
enforce_mfa=False,
no_mfa_grace_seconds=0,
profile="github",
**kwargs):
'''
Ensure a team is present
name
Thi... |
Ensure a team is absent. | def team_absent(name, profile="github", **kwargs):
'''
Ensure a team is absent.
Example:
.. code-block:: yaml
ensure team test is present in github:
github.team_absent:
- name: 'test'
The following parameters are required:
name
This is the name o... |
Ensure a repository is present | def repo_present(
name,
description=None,
homepage=None,
private=None,
has_issues=None,
has_wiki=None,
has_downloads=None,
auto_init=False,
gitignore_template=None,
license_template=None,
teams=None,
profile="github",
... |
Return the targets from the directory of flat yaml files checks opts for location. | def targets(tgt, tgt_type='glob', **kwargs):
'''
Return the targets from the directory of flat yaml files,
checks opts for location.
'''
roster_dir = __opts__.get('roster_dir', '/etc/salt/roster.d')
# Match the targets before rendering to avoid opening files unnecessarily.
raw = dict.fromkey... |
Render the roster file | def _render(roster_file, **kwargs):
"""
Render the roster file
"""
renderers = salt.loader.render(__opts__, {})
domain = __opts__.get('roster_domain', '')
try:
result = salt.template.compile_template(roster_file,
renderers,
... |
Convert a string to a number allowing for a K|M|G|T postfix 32. 8K. Returns a decimal number if the string is a real number or the string unchanged otherwise. | def _parse_numbers(text):
'''
Convert a string to a number, allowing for a K|M|G|T postfix, 32.8K.
Returns a decimal number if the string is a real number,
or the string unchanged otherwise.
'''
if text.isdigit():
return decimal.Decimal(text)
try:
postPrefixes = {'K': '10E3'... |
Sanitize flags passed into df | def _clean_flags(args, caller):
'''
Sanitize flags passed into df
'''
flags = ''
if args is None:
return flags
allowed = ('a', 'B', 'h', 'H', 'i', 'k', 'l', 'P', 't', 'T', 'x', 'v')
for flag in args:
if flag in allowed:
flags += flag
else:
rais... |
Return usage information for volumes mounted on this minion | def usage(args=None):
'''
Return usage information for volumes mounted on this minion
.. versionchanged:: 2019.2.0
Default for SunOS changed to 1 kilobyte blocks
CLI Example:
.. code-block:: bash
salt '*' disk.usage
'''
flags = _clean_flags(args, 'disk.usage')
if not... |
Return inode usage information for volumes mounted on this minion | def inodeusage(args=None):
'''
Return inode usage information for volumes mounted on this minion
CLI Example:
.. code-block:: bash
salt '*' disk.inodeusage
'''
flags = _clean_flags(args, 'disk.inodeusage')
if __grains__['kernel'] == 'AIX':
cmd = 'df -i'
else:
c... |
Return partition information for volumes mounted on this minion | def percent(args=None):
'''
Return partition information for volumes mounted on this minion
CLI Example:
.. code-block:: bash
salt '*' disk.percent /var
'''
if __grains__['kernel'] == 'Linux':
cmd = 'df -P'
elif __grains__['kernel'] == 'OpenBSD' or __grains__['kernel'] == ... |
Return block device attributes: UUID LABEL etc. This function only works on systems where blkid is available. | def blkid(device=None, token=None):
'''
Return block device attributes: UUID, LABEL, etc. This function only works
on systems where blkid is available.
device
Device name from the system
token
Any valid token used for the search
CLI Example:
.. code-block:: bash
... |
Set attributes for the specified device | def tune(device, **kwargs):
'''
Set attributes for the specified device
CLI Example:
.. code-block:: bash
salt '*' disk.tune /dev/sda1 read-ahead=1024 read-write=True
Valid options are: ``read-ahead``, ``filesystem-read-ahead``,
``read-only``, ``read-write``.
See the ``blockdev(... |
Remove the filesystem information | def wipe(device):
'''
Remove the filesystem information
CLI Example:
.. code-block:: bash
salt '*' disk.wipe /dev/sda1
'''
cmd = 'wipefs -a {0}'.format(device)
try:
out = __salt__['cmd.run_all'](cmd, python_shell=False)
except subprocess.CalledProcessError as err:
... |
Return all contents of dumpe2fs for a specified device | def dump(device, args=None):
'''
Return all contents of dumpe2fs for a specified device
CLI Example:
.. code-block:: bash
salt '*' disk.dump /dev/sda1
'''
cmd = 'blockdev --getro --getsz --getss --getpbsz --getiomin --getioopt --getalignoff ' \
'--getmaxsect --getsize --getsi... |
Resizes the filesystem. | def resize2fs(device):
'''
Resizes the filesystem.
CLI Example:
.. code-block:: bash
salt '*' disk.resize2fs /dev/sda1
'''
cmd = 'resize2fs {0}'.format(device)
try:
out = __salt__['cmd.run_all'](cmd, python_shell=False)
except subprocess.CalledProcessError as err:
... |
Format a filesystem onto a device | def format_(device,
fs_type='ext4',
inode_size=None,
lazy_itable_init=None,
fat=None,
force=False):
'''
Format a filesystem onto a device
.. versionadded:: 2016.11.0
device
The device in which to create the new filesystem
fs_type... |
Return the filesystem name of the specified device | def fstype(device):
'''
Return the filesystem name of the specified device
.. versionadded:: 2016.11.0
device
The name of the device
CLI Example:
.. code-block:: bash
salt '*' disk.fstype /dev/sdX1
'''
if salt.utils.path.which('lsblk'):
lsblk_out = __salt__['... |
Execute hdparm Fail hard when required return output when possible | def _hdparm(args, failhard=True):
'''
Execute hdparm
Fail hard when required
return output when possible
'''
cmd = 'hdparm {0}'.format(args)
result = __salt__['cmd.run_all'](cmd)
if result['retcode'] != 0:
msg = '{0}: {1}'.format(cmd, result['stderr'])
if failhard:
... |
Retrieve all info s for all disks parse em into a nice dict ( which considering hdparms output is quite a hassle ) | def hdparms(disks, args=None):
'''
Retrieve all info's for all disks
parse 'em into a nice dict
(which, considering hdparms output, is quite a hassle)
.. versionadded:: 2016.3.0
CLI Example:
.. code-block:: bash
salt '*' disk.hdparms /dev/sda
'''
all_parms = 'aAbBcCdgHiJkM... |
Get/ set Host Protected Area settings | def hpa(disks, size=None):
'''
Get/set Host Protected Area settings
T13 INCITS 346-2001 (1367D) defines the BEER (Boot Engineering Extension Record)
and PARTIES (Protected Area Run Time Interface Extension Services), allowing
for a Host Protected Area on a disk.
It's often used by OEMS to hide... |
Fetch SMART attributes Providing attributes will deliver only requested attributes Providing values will deliver only requested values for attributes | def smart_attributes(dev, attributes=None, values=None):
'''
Fetch SMART attributes
Providing attributes will deliver only requested attributes
Providing values will deliver only requested values for attributes
Default is the Backblaze recommended
set (https://www.backblaze.com/blog/hard-drive-... |
Gather and return ( averaged ) IO stats. | def iostat(interval=1, count=5, disks=None):
'''
Gather and return (averaged) IO stats.
.. versionadded:: 2016.3.0
.. versionchanged:: 2016.11.4
Added support for AIX
CLI Example:
.. code-block:: bash
salt '*' disk.iostat 1 5 disks=sda
'''
if salt.utils.platform.is_l... |
Transpose collected data average it stomp it in dict using header | def _iostats_dict(header, stats):
'''
Transpose collected data, average it, stomp it in dict using header
Use Decimals so we can properly calc & round, convert to float 'caus' we can't transmit Decimals over 0mq
'''
stats = [float((sum(stat) / len(stat)).quantize(decimal.Decimal('.01'))) for stat i... |
Tested on FreeBSD quite likely other BSD s only need small changes in cmd syntax | def _iostat_fbsd(interval, count, disks):
'''
Tested on FreeBSD, quite likely other BSD's only need small changes in cmd syntax
'''
if disks is None:
iostat_cmd = 'iostat -xC -w {0} -c {1} '.format(interval, count)
elif isinstance(disks, six.string_types):
iostat_cmd = 'iostat -x -w ... |
AIX support to gather and return ( averaged ) IO stats. | def _iostat_aix(interval, count, disks):
'''
AIX support to gather and return (averaged) IO stats.
'''
log.debug('DGM disk iostat entry')
if disks is None:
iostat_cmd = 'iostat -dD {0} {1} '.format(interval, count)
elif isinstance(disks, six.string_types):
iostat_cmd = 'iostat -... |
Validate the beacon configuration | def validate(config):
'''
Validate the beacon configuration
'''
valid = True
messages = []
if not isinstance(config, list):
valid = False
messages.append('[-] Configuration for %s beacon must be a list', config)
else:
_config = {}
list(map(_config.update, con... |
Check on different service status reported by the django - server - status library. | def beacon(config):
'''
Check on different service status reported by the django-server-status
library.
.. code-block:: yaml
beacons:
http_status:
- sites:
example-site-1:
url: "https://example.com/status"
timeout: 30
... |
Query a resource and decode the return data | def query(url, **kwargs):
'''
Query a resource, and decode the return data
Passes through all the parameters described in the
:py:func:`utils.http.query function <salt.utils.http.query>`:
.. autofunction:: salt.utils.http.query
CLI Example:
.. code-block:: bash
salt '*' http.que... |
Query a resource until a successful response and decode the return data | def wait_for_successful_query(url, wait_for=300, **kwargs):
'''
Query a resource until a successful response, and decode the return data
CLI Example:
.. code-block:: bash
salt '*' http.wait_for_successful_query http://somelink.com/ wait_for=160
'''
starttime = time.time()
while ... |
Update the local CA bundle file from a URL | def update_ca_bundle(target=None, source=None, merge_files=None):
'''
Update the local CA bundle file from a URL
.. versionadded:: 2015.5.0
CLI Example:
.. code-block:: bash
salt '*' http.update_ca_bundle
salt '*' http.update_ca_bundle target=/path/to/cacerts.pem
salt '*'... |
Check to see if a security group exists. | def exists(name=None, region=None, key=None, keyid=None, profile=None,
vpc_id=None, vpc_name=None, group_id=None):
'''
Check to see if a security group exists.
CLI example::
salt myminion boto_secgroup.exists mysecgroup
'''
conn = _get_conn(region=region, key=key, keyid=keyid, p... |
Split rules with combined grants into individual rules. | def _split_rules(rules):
'''
Split rules with combined grants into individual rules.
Amazon returns a set of rules with the same protocol, from and to ports
together as a single rule with a set of grants. Authorizing and revoking
rules, however, is done as a split set of rules. This function splits... |
Get a group object given a name name and vpc_id/ vpc_name or group_id. Return a boto. ec2. securitygroup. SecurityGroup object if the group is found else return None. | def _get_group(conn=None, name=None, vpc_id=None, vpc_name=None, group_id=None,
region=None, key=None, keyid=None, profile=None): # pylint: disable=W0613
'''
Get a group object given a name, name and vpc_id/vpc_name or group_id. Return
a boto.ec2.securitygroup.SecurityGroup object if the gro... |
Return a list of all Security Groups matching the given criteria and filters. | def get_all_security_groups(groupnames=None, group_ids=None, filters=None,
region=None, key=None, keyid=None, profile=None):
'''
Return a list of all Security Groups matching the given criteria and filters.
Note that the 'groupnames' argument only functions correctly for EC2 Cla... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.