saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-17 10:10:20 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

More Beryllium --> 2015.8.0 version reference changes

Browse source
This commit is contained in:
rallytime 2015-07-08 10:57:43 -06:00
parent abfae94e1d
commit b24911a3e1
40 changed files with 239 additions and 389 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
salt/modules/aptpkg.py
View file

@ -421,7 +421,7 @@ def install(name=None,
install --reinstall`` will only be used if the installed version
matches the requested version.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Multiple Package Installation Options:
@ -474,7 +474,7 @@ def install(name=None,
force_conf_new
Always install the new version of any configuration files.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Returns a dict containing the new package names and versions::
@ -733,7 +733,7 @@ def autoremove(list_only=False, purge=False):
purge : False
Also remove package config data when autoremoving packages.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -851,7 +851,7 @@ def upgrade(refresh=True, dist_upgrade=False, **kwargs):
force_conf_new
Always install the new version of any configuration files.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -1550,7 +1550,7 @@ def del_repo(repo, **kwargs):
def del_repo_key(name=None, **kwargs):
'''
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Remove a repo key using ``apt-key del``

4
salt/modules/archive.py
View file

@ -57,7 +57,7 @@ def tar(options, tarfile, sources=None, dest=None,
options
Options to pass to the tar command
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
The mandatory `-` prefixing has been removed. An options string
beginning with a `--long-option`, would have uncharacteristically
@ -420,7 +420,7 @@ def cmd_unzip(zip_file, dest, excludes=None,
options : None
Additional command-line options to pass to the ``unzip`` binary.
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
The mandatory `-` prefixing has been removed. An options string
beginning with a `--long-option`, would have uncharacteristically

2
salt/modules/bamboohr.py
View file

@ -2,7 +2,7 @@
'''
Support for BambooHR
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Requires a ``subdomain`` and an ``apikey`` in ``/etc/salt/minion``:

20
salt/modules/beacons.py
View file

@ -2,7 +2,7 @@
'''
Module for managing the Salt beacons on a minion
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
'''
@ -27,8 +27,6 @@ def list_(return_yaml=True):
'''
List the beacons currently configured on the minion
.. versionadded:: Beryllium
:param return_yaml: Whether to return YAML formatted output, default True
:return: List of currently configured Beacons.
@ -70,8 +68,6 @@ def add(name, beacon_data, **kwargs):
'''
Add a beacon on the minion
.. versionadded:: Beryllium
:param name: Name of the beacon to configure
:param beacon_data: Dictionary or list containing configuration for beacon.
:return: Boolean and status message on success or failure of add.
@ -135,8 +131,6 @@ def modify(name, beacon_data, **kwargs):
'''
Modify an existing beacon
.. versionadded:: Beryllium
:param name: Name of the beacon to configure
:param beacon_data: Dictionary or list containing updated configuration for beacon.
:return: Boolean and status message on success or failure of modify.
@ -217,8 +211,6 @@ def delete(name, **kwargs):
'''
Delete a beacon item
.. versionadded:: Beryllium
:param name: Name of the beacon to delete
:return: Boolean and status message on success or failure of delete.
@ -260,8 +252,6 @@ def save():
'''
Save all beacons on the minion
.. versionadded:: Beryllium
:return: Boolean and status message on success or failure of save.
CLI Example:
@ -299,8 +289,6 @@ def enable(**kwargs):
'''
Enable all beacons on the minion
.. versionadded:: Beryllium
:return: Boolean and status message on success or failure of enable.
CLI Example:
@ -340,8 +328,6 @@ def disable(**kwargs):
'''
Disable all beaconsd jobs on the minion
.. versionadded:: Beryllium
:return: Boolean and status message on success or failure of disable.
CLI Example:
@ -382,8 +368,6 @@ def enable_beacon(name, **kwargs):
'''
Enable beacon on the minion
.. versionadded:: Beryllium
:name: Name of the beacon to enable.
:return: Boolean and status message on success or failure of enable.
@ -432,8 +416,6 @@ def disable_beacon(name, **kwargs):
'''
Disable beacon on the minion
.. versionadded:: Beryllium
:name: Name of the beacon to enable.
:return: Boolean and status message on success or failure of disable.

16
salt/modules/boto_cfn.py
View file

@ -2,7 +2,7 @@
'''
Connection module for Amazon Cloud Formation
.. versionadded:: Beryllium
.. versionadded:: 2015.5.0
:configuration: This module accepts explicit AWS credentials but can also utilize
IAM roles assigned to the instance trough Instance Profiles. Dynamic
@ -71,8 +71,6 @@ def exists(name, region=None, key=None, keyid=None, profile=None):
'''
Check to see if a stack exists.
.. versionadded:: Beryllium
CLI example::
salt myminion boto_cfn.exists mystack region=us-east-1
@ -93,7 +91,7 @@ def describe(name, region=None, key=None, keyid=None, profile=None):
'''
Describe a stack.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI example::
@ -131,8 +129,6 @@ def create(name, template_body=None, template_url=None, parameters=None, notific
'''
Create a CFN stack.
.. versionadded:: Beryllium
CLI example to create a stack::
salt myminion boto_cfn.create mystack template_url='https://s3.amazonaws.com/bucket/template.cft' \
@ -157,7 +153,7 @@ def update_stack(name, template_body=None, template_url=None, parameters=None, n
'''
Update a CFN stack.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI example to update a stack::
@ -184,8 +180,6 @@ def delete(name, region=None, key=None, keyid=None, profile=None):
'''
Delete a CFN stack.
.. versionadded:: Beryllium
CLI example to delete a stack::
salt myminion boto_cfn.delete mystack region=us-east-1
@ -205,8 +199,6 @@ def get_template(name, region=None, key=None, keyid=None, profile=None):
'''
Check to see if attributes are set on a CFN stack.
.. versionadded:: Beryllium
CLI example::
salt myminion boto_cfn.get_template mystack
@ -228,7 +220,7 @@ def validate_template(template_body=None, template_url=None, region=None, key=No
'''
Validate cloudformation template
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI example::

48
salt/modules/boto_iam.py
View file

@ -205,7 +205,7 @@ def create_user(user_name, path=None, region=None, key=None, keyid=None,
'''
Create a user.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -234,7 +234,7 @@ def get_all_access_keys(user_name, marker=None, max_items=None,
'''
Get all access keys from a user.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -255,7 +255,7 @@ def create_access_key(user_name, region=None, key=None, keyid=None, profile=None
'''
Create access key id for a user.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -277,7 +277,7 @@ def delete_access_key(access_key_id, user_name=None, region=None, key=None,
'''
Delete access key id from a user.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -299,7 +299,7 @@ def delete_user(user_name, region=None, key=None, keyid=None,
'''
Delete a user.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -324,7 +324,7 @@ def get_user(user_name=None, region=None, key=None, keyid=None, profile=None):
'''
Get user information.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -350,7 +350,7 @@ def create_group(group_name, path=None, region=None, key=None, keyid=None,
'''
Create a group.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -379,7 +379,7 @@ def get_group(group_name, marker=None, max_items=None, region=None, key=None,
'''
Get group information.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -405,7 +405,7 @@ def add_user_to_group(user_name, group_name, region=None, key=None, keyid=None,
'''
Add user to group.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -439,7 +439,7 @@ def user_exists_in_group(user_name, group_name, region=None, key=None, keyid=Non
'''
Check if user exists in group.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -463,7 +463,7 @@ def remove_user_from_group(group_name, user_name, region=None, key=None, keyid=N
'''
Remove user from group.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -497,7 +497,7 @@ def put_group_policy(group_name, policy_name, policy_json, region=None, key=None
'''
Adds or updates the specified policy document for the specified group.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -563,7 +563,7 @@ def get_group_policy(group_name, policy_name, region=None, key=None,
'''
Retrieves the specified policy document for the specified group.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -617,7 +617,7 @@ def create_login_profile(user_name, password, region=None, key=None,
Creates a login profile for the specified user, give the user the
ability to access AWS services and the AWS Management Console.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -657,7 +657,7 @@ def update_account_password_policy(allow_users_to_change_password=None,
'''
Update the password policy for the AWS account.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -687,7 +687,7 @@ def get_account_policy(region=None, key=None, keyid=None, profile=None):
'''
Get account policy for the AWS account.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -973,7 +973,7 @@ def update_assume_role_policy(role_name, policy_document, region=None,
'''
Update an assume role policy for a role.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -1003,7 +1003,7 @@ def build_policy(region=None, key=None, keyid=None, profile=None):
'''
Build a default assume role policy.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -1077,7 +1077,7 @@ def get_all_user_policies(user_name, marker=None, max_items=None, region=None, k
'''
Get all user policies.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -1103,7 +1103,7 @@ def get_user_policy(user_name, policy_name, region=None, key=None, keyid=None, p
'''
Retrieves the specified policy document for the specified user.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -1132,7 +1132,7 @@ def put_user_policy(user_name, policy_name, policy_json, region=None, key=None,
'''
Adds or updates the specified policy document for the specified user.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -1197,7 +1197,7 @@ def upload_server_cert(cert_name, cert_body, private_key, cert_chain=None, path=
'''
Upload a certificate to Amazon.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -1236,7 +1236,7 @@ def get_server_certificate(cert_name, region=None, key=None, keyid=None, profile
'''
Returns certificate information from Amazon
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -1261,7 +1261,7 @@ def delete_server_cert(cert_name, region=None, key=None, keyid=None, profile=Non
'''
Deletes a certificate from Amazon.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:

2
salt/modules/boto_rds.py
View file

@ -2,7 +2,7 @@
'''
Connection module for Amazon RDS
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
:configuration: This module accepts explicit rds credentials but can also
utilize IAM roles assigned to the instance trough Instance Profiles.

6
salt/modules/boto_route53.py
View file

@ -103,7 +103,7 @@ def zone_exists(zone, region=None, key=None, keyid=None, profile=None):
'''
Check for the existence of a Route53 hosted zone.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example::
@ -119,7 +119,7 @@ def create_zone(zone, private=False, vpc_id=None, vpc_region=None, region=None,
'''
Create a Route53 hosted zone.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example::
@ -141,7 +141,7 @@ def delete_zone(zone, region=None, key=None, keyid=None, profile=None):
'''
Delete a Route53 hosted zone.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example::

38
salt/modules/boto_vpc.py
View file

@ -39,7 +39,7 @@ Connection module for Amazon VPC
key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
region: us-east-1
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
All methods now return a dictionary. Create and delete methods return:
.. code-block:: yaml
@ -357,7 +357,7 @@ def get_resource_id(resource, name=None, resource_id=None, region=None,
'''
Get an AWS id for a VPC resource by type and name.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -381,7 +381,7 @@ def resource_exists(resource, name=None, resource_id=None, tags=None,
{exists: false} if it does not exist, or {error: {message: error text}
on error.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -616,7 +616,7 @@ def describe(vpc_id=None, vpc_name=None, region=None, key=None,
Returns a dictionary of interesting properties.
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
Added vpc_name argument
CLI Example:
@ -662,7 +662,7 @@ def describe_vpcs(vpc_id=None, name=None, cidr=None, tags=None,
Returns a a list of dictionaries with interesting properties.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -754,7 +754,7 @@ def create_subnet(vpc_id=None, cidr_block=None, vpc_name=None,
Returns True if the VPC subnet was created and returns False if the VPC subnet was not created.
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
Added vpc_name argument
CLI Examples:
@ -787,7 +787,7 @@ def delete_subnet(subnet_id=None, subnet_name=None, region=None, key=None,
Returns True if the subnet was deleted and returns False if the subnet was not deleted.
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
Added subnet_name argument
CLI Example:
@ -811,7 +811,7 @@ def subnet_exists(subnet_id=None, name=None, subnet_name=None, cidr=None,
Returns True if the subnet exists, otherwise returns False.
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
Added subnet_name argument
Deprecated name argument
@ -917,7 +917,7 @@ def describe_subnet(subnet_id=None, subnet_name=None, region=None,
Returns a dictionary of interesting properties.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Examples:
@ -949,7 +949,7 @@ def describe_subnets(subnet_ids=None, subnet_names=None, vpc_id=None, cidr=None,
If a subnet id or CIDR is provided, only its associated subnet details will be
returned.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Examples:
@ -1014,7 +1014,7 @@ def create_internet_gateway(internet_gateway_name=None, vpc_id=None,
Returns the internet gateway id if the internet gateway was created and
returns False if the internet gateways was not created.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
.. code-block:: bash
@ -1053,7 +1053,7 @@ def delete_internet_gateway(internet_gateway_id=None,
Returns True if the internet gateway was deleted and otherwise False.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Examples:
@ -1131,7 +1131,7 @@ def delete_customer_gateway(customer_gateway_id=None, customer_gateway_name=None
Returns True if the customer gateway was deleted and returns False if the customer gateway was not deleted.
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
Added customer_gateway_name argument
CLI Example:
@ -1180,7 +1180,7 @@ def create_dhcp_options(domain_name=None, domain_name_servers=None, ntp_servers=
Returns True if the DHCP options record was created and returns False if the DHCP options record was not deleted.
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
Added vpc_name and vpc_id arguments
CLI Example:
@ -1222,7 +1222,7 @@ def delete_dhcp_options(dhcp_options_id=None, dhcp_options_name=None,
'''
Delete dhcp options by id or name.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -1333,7 +1333,7 @@ def create_network_acl(vpc_id=None, vpc_name=None, network_acl_name=None,
Returns the network acl id if successful, otherwise returns False.
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
Added vpc_name, subnet_id, and subnet_name arguments
CLI Example:
@ -1703,7 +1703,7 @@ def create_route_table(vpc_id=None, vpc_name=None, route_table_name=None,
'''
Creates a route table.
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
Added vpc_name argument
CLI Examples:
@ -1771,7 +1771,7 @@ def route_exists(destination_cidr_block, route_table_name=None, route_table_id=N
'''
Checks if a route exists.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -2073,7 +2073,7 @@ def describe_route_table(route_table_id=None, route_table_name=None,
'''
Given route table properties, return route table details if matching table(s) exist.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:

6
salt/modules/container_resource.py
View file

@ -2,7 +2,7 @@
'''
Common resources for LXC and systemd-nspawn containers
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
These functions are not designed to be called directly, but instead from the
:mod:`lxc <salt.modules.lxc>`, :mod:`nspawn <salt.modules.nspawn>`, and
@ -134,8 +134,6 @@ def run(name,
path to the container parent (for LXC only)
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
CLI Example:
.. code-block:: bash
@ -283,8 +281,6 @@ def copy_to(name,
path to the container parent (for LXC only)
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
CLI Example:
.. code-block:: bash

14
salt/modules/data.py
View file

@ -106,7 +106,7 @@ def getval(key):
'''
Get a value from the minion datastore
.. deprecated:: Beryllium
.. deprecated:: 2015.8.0
Use ``get`` instead
CLI Example:
@ -122,7 +122,7 @@ def getvals(*keylist):
'''
Get values from the minion datastore
.. deprecated:: Beryllium
.. deprecated:: 2015.8.0
Use ``get`` instead
CLI Example:
@ -178,7 +178,7 @@ def get(key, default=None):
'''
Get a (list of) value(s) from the minion datastore
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -200,7 +200,7 @@ def keys():
'''
Get all keys from the minion datastore
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -216,7 +216,7 @@ def values():
'''
Get values from the minion datastore
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -232,7 +232,7 @@ def items():
'''
Get items from the minion datastore
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -248,7 +248,7 @@ def has_key(key):
'''
Check if key is in the minion datastore
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:

2
salt/modules/dockerio.py
View file

@ -817,7 +817,7 @@ def kill(container, signal=None):
signal
signal to send
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:

2
salt/modules/dockerng.py
View file

@ -2,7 +2,7 @@
'''
Management of Docker Containers
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Why Make a Second Docker Module?

2
salt/modules/dpkg.py
View file

@ -27,7 +27,7 @@ def __virtual__():
def bin_pkg_info(path, saltenv='base'):
'''
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Parses RPM metadata and returns a dictionary of information about the
package (name, version, etc.).

4
salt/modules/ebuild.py
View file

@ -304,7 +304,7 @@ def list_upgrades(refresh=True, backtrack=3):
calculation fails due to a conflict or an unsatisfied dependency
(default: ´3´).
.. versionadded: Beryllium
.. versionadded: 2015.8.0
CLI Example:
@ -740,7 +740,7 @@ def upgrade(refresh=True, binhost=None, backtrack=3):
calculation fails due to a conflict or an unsatisfied dependency
(default: ´3´).
.. versionadded: Beryllium
.. versionadded: 2015.8.0
Return a dict containing the new package names and versions::

8
salt/modules/file.py
View file

@ -1228,7 +1228,7 @@ def line(path, content, match=None, mode=None, location=None,
before=None, after=None, show_changes=True, backup=False,
quiet=False, indent=True):
'''
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Edit a line in the configuration file.
@ -1547,14 +1547,14 @@ def replace(path,
(the original version and the edited version) in order to generate the
diff.
ignore_if_missing
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
When this parameter is ``True``, ``file.replace`` will return ``False`` if the
file doesn't exist. When this parameter is ``False``, ``file.replace`` will
throw an error if the file doesn't exist.
Default is ``False`` (to maintain compatibility with prior behaviour).
preserve_inode
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Preserve the inode of the file, so that any hard links continue to share the
inode with the original filename. This works by *copying* the file, reading
@ -2015,7 +2015,7 @@ def search(path,
If true, inserts 'MULTILINE' into ``flags`` and sets ``bufsize`` to
'file'.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:

22
salt/modules/firewalld.py
View file

@ -413,7 +413,7 @@ def add_masquerade(zone):
'''
Enable masquerade on a zone.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -428,7 +428,7 @@ def remove_masquerade(zone):
'''
Remove masquerade on a zone.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -443,7 +443,7 @@ def add_port(zone, port):
'''
Allow specific ports in a zone.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -461,7 +461,7 @@ def remove_port(zone, port):
'''
Remove a specific port from a zone.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -476,7 +476,7 @@ def list_ports(zone):
'''
List all ports in a zone.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -491,7 +491,7 @@ def add_port_fwd(zone, src, dest, proto='tcp', dstaddr=''):
'''
Add port forwarding.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -517,7 +517,7 @@ def remove_port_fwd(zone, src, dest, proto='tcp'):
'''
Remove Port Forwarding.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -539,7 +539,7 @@ def list_port_fwd(zone):
'''
List port forwarding
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -566,7 +566,7 @@ def block_icmp(zone, icmp):
'''
Block a specific ICMP type on a zone
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -589,7 +589,7 @@ def allow_icmp(zone, icmp):
'''
Allow a specific ICMP type on a zone
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -612,7 +612,7 @@ def list_icmp_block(zone):
'''
List ICMP blocks on a zone
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:

2
salt/modules/gem.py
View file

@ -225,7 +225,7 @@ def list_upgrades(ruby=None,
runas=None,
gem_bin=None):
'''
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Check if an upgrade is available for installed gems

104
salt/modules/lxc.py
View file

@ -88,7 +88,7 @@ def get_root_path(path):
'''
Get the configured lxc root for containers
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -106,7 +106,7 @@ def version():
'''
Return the actual lxc client version
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -261,7 +261,7 @@ def cloud_init_interface(name, vm_=None, **kwargs):
path
path to the container parent directory (default: /var/lib/lxc)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
profile
:ref:`profile <tutorial-lxc-profiles-container>` selection
@ -1261,7 +1261,7 @@ def init(name,
path to the container parent directory
default: /var/lib/lxc (system)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
clone
.. deprecated:: 2015.5.0
@ -1878,7 +1878,7 @@ def create(name,
path
parent path for the container creation (default: /var/lib/lxc)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
'''
# Required params for 'download' template
download_template_deps = ('dist', 'release', 'arch')
@ -2012,7 +2012,7 @@ def clone(name,
path to the container parent directory
default: /var/lib/lxc (system)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
**Container Cloning Arguments**
@ -2029,12 +2029,12 @@ def clone(name,
network_profile
Network profile to use for container
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
nic_opts
give extra opts overriding network profile values
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Examples:
@ -2110,7 +2110,7 @@ def ls_(active=None, cache=True, path=None):
path to the container parent directory
default: /var/lib/lxc (system)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
active
If ``True``, return only active (i.e. running) containers
@ -2157,7 +2157,7 @@ def list_(extra=False, limit=None, path=None):
path to the container parent directory
default: /var/lib/lxc (system)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
limit
Return output matching a specific state (**frozen**, **running**, or
@ -2314,7 +2314,7 @@ def _ensure_running(name, no_start=False, path=None):
path to the container parent directory
default: /var/lib/lxc (system)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
'''
_ensure_exists(name, path=path)
pre = state(name, path=path)
@ -2350,14 +2350,14 @@ def restart(name, path=None, lxc_config=None, force=False):
path to the container parent directory
default: /var/lib/lxc (system)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
lxc_config
path to a lxc config file
config file will be guessed from container name otherwise
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
force : False
If ``True``, the container will be force-stopped instead of gracefully
@ -2394,19 +2394,19 @@ def start(name, **kwargs):
path to the container parent directory
default: /var/lib/lxc (system)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
lxc_config
path to a lxc config file
config file will be guessed from container name otherwise
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
use_vt
run the command through VT
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -2456,7 +2456,7 @@ def stop(name, kill=False, path=None, use_vt=None):
path to the container parent directory
default: /var/lib/lxc (system)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
kill: False
Do not wait for the container to stop, kill all tasks in the container.
@ -2469,7 +2469,7 @@ def stop(name, kill=False, path=None, use_vt=None):
use_vt
run the command through VT
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -2500,7 +2500,7 @@ def freeze(name, **kwargs):
path to the container parent directory
default: /var/lib/lxc (system)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
start : False
If ``True`` and the container is stopped, the container will be started
@ -2511,7 +2511,7 @@ def freeze(name, **kwargs):
use_vt
run the command through VT
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -2549,12 +2549,12 @@ def unfreeze(name, path=None, use_vt=None):
path to the container parent directory
default: /var/lib/lxc (system)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
use_vt
run the command through VT
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -2584,7 +2584,7 @@ def destroy(name, stop=False, path=None):
path
path to the container parent directory (default: /var/lib/lxc)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
stop : False
If ``True``, the container will be destroyed even if it is
@ -2621,7 +2621,7 @@ def exists(name, path=None):
path
path to the container parent directory (default: /var/lib/lxc)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -2646,7 +2646,7 @@ def state(name, path=None):
path
path to the container parent directory (default: /var/lib/lxc)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -2692,7 +2692,7 @@ def get_parameter(name, parameter, path=None):
path to the container parent directory
default: /var/lib/lxc (system)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -2721,7 +2721,7 @@ def set_parameter(name, parameter, value, path=None):
path to the container parent directory
default: /var/lib/lxc (system)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -2751,7 +2751,7 @@ def info(name, path=None):
path to the container parent directory
default: /var/lib/lxc (system)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -2915,7 +2915,7 @@ def set_password(name, users, password, encrypted=True, path=None):
path to the container parent directory
default: /var/lib/lxc (system)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -2966,7 +2966,7 @@ def update_lxc_conf(name, lxc_conf, lxc_conf_unset, path=None):
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -3074,7 +3074,7 @@ def set_dns(name, dnsservers=None, searchdomains=None, path=None):
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -3164,7 +3164,7 @@ def running_systemd(name, cache=True, path=None):
path
path to the container parent
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -3242,7 +3242,7 @@ def systemd_running_state(name, path=None):
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -3270,7 +3270,7 @@ def test_sd_started_state(name, path=None):
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -3299,7 +3299,7 @@ def test_bare_started_state(name, path=None):
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -3330,7 +3330,7 @@ def wait_started(name, path=None, timeout=300):
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -3419,7 +3419,7 @@ def bootstrap(name,
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
pub_key
Explicit public key to pressed the minion with (optional).
@ -3598,7 +3598,7 @@ def attachable(name, path=None):
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -3646,7 +3646,7 @@ def _run(name,
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
'''
orig_state = state(name, path=path)
@ -3717,7 +3717,7 @@ def run_cmd(name,
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
.. deprecated:: 2015.5.0
Use :mod:`lxc.run <salt.modules.lxc.run>` instead
@ -3763,7 +3763,7 @@ def run(name,
chroot_fallback=False,
keep_env='http_proxy,https_proxy,no_proxy'):
'''
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Run :mod:`cmd.run <salt.modules.cmdmod.run>` within a container
@ -3791,7 +3791,7 @@ def run(name,
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
no_start : False
If the container is not running, don't start it
@ -3880,7 +3880,7 @@ def run_stdout(name,
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
no_start : False
If the container is not running, don't start it
@ -3967,7 +3967,7 @@ def run_stderr(name,
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
no_start : False
If the container is not running, don't start it
@ -4062,7 +4062,7 @@ def retcode(name,
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
stdin : None
Standard input to be used for the command
@ -4146,7 +4146,7 @@ def run_all(name,
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
cmd
Command to run
@ -4213,7 +4213,7 @@ def _get_md5(name, path):
def copy_to(name, source, dest, overwrite=False, makedirs=False, path=None):
'''
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
Function renamed from ``lxc.cp`` to ``lxc.copy_to`` for consistency
with other container types. ``lxc.cp`` will continue to work, however.
For versions 2015.2.x and earlier, use ``lxc.cp``.
@ -4230,7 +4230,7 @@ def copy_to(name, source, dest, overwrite=False, makedirs=False, path=None):
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
dest
Destination on the container. Must be an absolute path.
@ -4243,7 +4243,7 @@ def copy_to(name, source, dest, overwrite=False, makedirs=False, path=None):
Unless this option is set to ``True``, then if a file exists at the
location specified by the ``dest`` argument, an error will be raised.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
makedirs : False
@ -4503,7 +4503,7 @@ def reboot(name, path=None):
path to the container parent
default: /var/lib/lxc (system default)
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Examples:
@ -4587,7 +4587,7 @@ def reconfigure(name,
path
path to the container parent
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -4666,7 +4666,7 @@ def apply_network_profile(name, network_profile, nic_opts=None, path=None):
path
path to the container parent
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Examples:

2
salt/modules/mod_random.py
View file

@ -151,7 +151,7 @@ def seed(range=10, hash=None):
Returns a random number within a range. Optional hash argument can
be any hashable object. If hash is omitted or None, the id of the minion is used.
.. versionadded: Beryllium
.. versionadded: 2015.8.0
hash: None
Any hashable object.

2
salt/modules/nagios_rpc.py
View file

@ -2,7 +2,7 @@
'''
Check Host & Service status from Nagios via JSON RPC.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
'''

8
salt/modules/network.py
View file

@ -737,7 +737,7 @@ def calc_net(ip_addr, netmask=None):
salt '*' network.calc_net 172.17.0.5 255.255.255.240
salt '*' network.calc_net 2a02:f6e:a000:80:84d8:8332:7866:4e07/64
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
'''
return salt.utils.network.calc_net(ip_addr, netmask)
@ -961,7 +961,7 @@ def is_private(ip_addr):
Check if the given IP address is a private address
.. versionadded:: 2014.7.0
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
IPv6 support
CLI Example:
@ -978,7 +978,7 @@ def is_loopback(ip_addr):
Check if the given IP address is a loopback address
.. versionadded:: 2014.7.0
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
IPv6 support
CLI Example:
@ -994,7 +994,7 @@ def reverse_ip(ip_addr):
'''
Returns the reversed IP address
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
IPv6 support
CLI Example:

2
salt/modules/nspawn.py
View file

@ -2,7 +2,7 @@
'''
Manage nspawn containers
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
`systemd-nspawn(1)`__ is a tool used to manage lightweight namespace
containers. This execution module provides several functions to help manage

144
salt/modules/osquery.py
View file

@ -1,6 +1,8 @@
# -*- coding: utf-8 -*-
'''
Support for OSQuery - https://osquery.io
Support for OSQuery - https://osquery.io.
.. versionadded:: 2015.8.0
'''
from __future__ import absolute_import
@ -106,8 +108,6 @@ def _osquery_cmd(table, attrs=None, where=None, format='json'):
def version():
'''
.. versionadded:: Beryllium
Return version of osquery
CLI Example:
@ -123,8 +123,6 @@ def version():
def rpm_packages(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return cpuid information from osquery
CLI Example:
@ -140,8 +138,6 @@ def rpm_packages(attrs=None, where=None):
def kernel_integrity(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return kernel_integrity information from osquery
CLI Example:
@ -157,8 +153,6 @@ def kernel_integrity(attrs=None, where=None):
def kernel_modules(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return kernel_modules information from osquery
CLI Example:
@ -174,8 +168,6 @@ def kernel_modules(attrs=None, where=None):
def memory_map(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return memory_map information from osquery
CLI Example:
@ -191,8 +183,6 @@ def memory_map(attrs=None, where=None):
def process_memory_map(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return process_memory_map information from osquery
CLI Example:
@ -208,8 +198,6 @@ def process_memory_map(attrs=None, where=None):
def shared_memory(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return shared_memory information from osquery
CLI Example:
@ -225,8 +213,6 @@ def shared_memory(attrs=None, where=None):
def apt_sources(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return apt_sources information from osquery
CLI Example:
@ -242,8 +228,6 @@ def apt_sources(attrs=None, where=None):
def deb_packages(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return deb_packages information from osquery
CLI Example:
@ -259,8 +243,6 @@ def deb_packages(attrs=None, where=None):
def acpi_tables(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return acpi_tables information from osquery
CLI Example:
@ -274,8 +256,6 @@ def acpi_tables(attrs=None, where=None):
def arp_cache(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return arp_cache information from osquery
CLI Example:
@ -289,8 +269,6 @@ def arp_cache(attrs=None, where=None):
def block_devices(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return block_devices information from osquery
CLI Example:
@ -304,8 +282,6 @@ def block_devices(attrs=None, where=None):
def cpuid(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return cpuid information from osquery
CLI Example:
@ -319,8 +295,6 @@ def cpuid(attrs=None, where=None):
def crontab(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return crontab information from osquery
CLI Example:
@ -334,8 +308,6 @@ def crontab(attrs=None, where=None):
def etc_hosts(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return etc_hosts information from osquery
CLI Example:
@ -362,8 +334,6 @@ def etc_services(attrs=None, where=None):
def file_changes(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return file_changes information from osquery
CLI Example:
@ -377,8 +347,6 @@ def file_changes(attrs=None, where=None):
def groups(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return groups information from osquery
CLI Example:
@ -392,8 +360,6 @@ def groups(attrs=None, where=None):
def hardware_events(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return hardware_events information from osquery
CLI Example:
@ -407,8 +373,6 @@ def hardware_events(attrs=None, where=None):
def interface_addresses(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return interface_addresses information from osquery
CLI Example:
@ -422,8 +386,6 @@ def interface_addresses(attrs=None, where=None):
def interface_details(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return interface_details information from osquery
CLI Example:
@ -437,8 +399,6 @@ def interface_details(attrs=None, where=None):
def kernel_info(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return kernel_info information from osquery
CLI Example:
@ -452,8 +412,6 @@ def kernel_info(attrs=None, where=None):
def last(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return last information from osquery
CLI Example:
@ -467,8 +425,6 @@ def last(attrs=None, where=None):
def listening_ports(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return listening_ports_ information from osquery
CLI Example:
@ -482,8 +438,6 @@ def listening_ports(attrs=None, where=None):
def logged_in_users(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return logged_in_users_ information from osquery
CLI Example:
@ -497,8 +451,6 @@ def logged_in_users(attrs=None, where=None):
def mounts(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return mounts_ information from osquery
CLI Example:
@ -512,8 +464,6 @@ def mounts(attrs=None, where=None):
def os_version(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return os_version information from osquery
CLI Example:
@ -527,8 +477,6 @@ def os_version(attrs=None, where=None):
def passwd_changes(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return passwd_changes information from osquery
CLI Example:
@ -542,8 +490,6 @@ def passwd_changes(attrs=None, where=None):
def pci_devices(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return pci_devices information from osquery
CLI Example:
@ -557,8 +503,6 @@ def pci_devices(attrs=None, where=None):
def process_envs(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return process_envs information from osquery
CLI Example:
@ -572,8 +516,6 @@ def process_envs(attrs=None, where=None):
def process_open_files(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return process_open_files information from osquery
CLI Example:
@ -587,8 +529,6 @@ def process_open_files(attrs=None, where=None):
def process_open_sockets(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return process_open_sockets information from osquery
CLI Example:
@ -602,8 +542,6 @@ def process_open_sockets(attrs=None, where=None):
def processes(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return processes information from osquery
CLI Example:
@ -617,8 +555,6 @@ def processes(attrs=None, where=None):
def routes(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return routes information from osquery
CLI Example:
@ -632,8 +568,6 @@ def routes(attrs=None, where=None):
def shell_history(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return shell_history information from osquery
CLI Example:
@ -647,8 +581,6 @@ def shell_history(attrs=None, where=None):
def smbios_tables(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return smbios_tables information from osquery
CLI Example:
@ -662,8 +594,6 @@ def smbios_tables(attrs=None, where=None):
def suid_bin(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return suid_bin information from osquery
CLI Example:
@ -677,8 +607,6 @@ def suid_bin(attrs=None, where=None):
def system_controls(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return system_controls information from osquery
CLI Example:
@ -692,8 +620,6 @@ def system_controls(attrs=None, where=None):
def usb_devices(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return usb_devices information from osquery
CLI Example:
@ -707,8 +633,6 @@ def usb_devices(attrs=None, where=None):
def users(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return users information from osquery
CLI Example:
@ -722,8 +646,6 @@ def users(attrs=None, where=None):
def alf(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return alf information from osquery
CLI Example:
@ -739,8 +661,6 @@ def alf(attrs=None, where=None):
def alf_exceptions(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return alf_exceptions information from osquery
CLI Example:
@ -756,8 +676,6 @@ def alf_exceptions(attrs=None, where=None):
def alf_explicit_auths(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return alf_explicit_auths information from osquery
CLI Example:
@ -773,8 +691,6 @@ def alf_explicit_auths(attrs=None, where=None):
def alf_services(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return alf_services information from osquery
CLI Example:
@ -790,8 +706,6 @@ def alf_services(attrs=None, where=None):
def apps(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return apps information from osquery
CLI Example:
@ -807,8 +721,6 @@ def apps(attrs=None, where=None):
def certificates(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return certificates information from osquery
CLI Example:
@ -824,8 +736,6 @@ def certificates(attrs=None, where=None):
def chrome_extensions(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return chrome_extensions information from osquery
CLI Example:
@ -841,8 +751,6 @@ def chrome_extensions(attrs=None, where=None):
def firefox_addons(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return firefox_addons information from osquery
CLI Example:
@ -858,8 +766,6 @@ def firefox_addons(attrs=None, where=None):
def homebrew_packages(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return homebrew_packages information from osquery
CLI Example:
@ -875,8 +781,6 @@ def homebrew_packages(attrs=None, where=None):
def iokit_devicetree(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return iokit_devicetree information from osquery
CLI Example:
@ -892,8 +796,6 @@ def iokit_devicetree(attrs=None, where=None):
def iokit_registry(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return iokit_registry information from osquery
CLI Example:
@ -909,8 +811,6 @@ def iokit_registry(attrs=None, where=None):
def kernel_extensions(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return kernel_extensions information from osquery
CLI Example:
@ -926,8 +826,6 @@ def kernel_extensions(attrs=None, where=None):
def keychain_items(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return keychain_items information from osquery
CLI Example:
@ -943,8 +841,6 @@ def keychain_items(attrs=None, where=None):
def launchd(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return launchd information from osquery
CLI Example:
@ -960,8 +856,6 @@ def launchd(attrs=None, where=None):
def nfs_shares(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return nfs_shares information from osquery
CLI Example:
@ -977,8 +871,6 @@ def nfs_shares(attrs=None, where=None):
def nvram(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return nvram information from osquery
CLI Example:
@ -994,8 +886,6 @@ def nvram(attrs=None, where=None):
def preferences(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return preferences information from osquery
CLI Example:
@ -1011,8 +901,6 @@ def preferences(attrs=None, where=None):
def quarantine(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return quarantine information from osquery
CLI Example:
@ -1028,8 +916,6 @@ def quarantine(attrs=None, where=None):
def safari_extensions(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return safari_extensions information from osquery
CLI Example:
@ -1045,8 +931,6 @@ def safari_extensions(attrs=None, where=None):
def startup_items(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return startup_items information from osquery
CLI Example:
@ -1062,8 +946,6 @@ def startup_items(attrs=None, where=None):
def xattr_where_from(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return xattr_where_from information from osquery
CLI Example:
@ -1079,8 +961,6 @@ def xattr_where_from(attrs=None, where=None):
def xprotect_entries(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return xprotect_entries information from osquery
CLI Example:
@ -1096,8 +976,6 @@ def xprotect_entries(attrs=None, where=None):
def xprotect_reports(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return xprotect_reports information from osquery
CLI Example:
@ -1113,8 +991,6 @@ def xprotect_reports(attrs=None, where=None):
def file_(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return file information from osquery
CLI Example:
@ -1128,8 +1004,6 @@ def file_(attrs=None, where=None):
def hash_(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return hash information from osquery
CLI Example:
@ -1143,8 +1017,6 @@ def hash_(attrs=None, where=None):
def osquery_extensions(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return osquery_extensions information from osquery
CLI Example:
@ -1158,8 +1030,6 @@ def osquery_extensions(attrs=None, where=None):
def osquery_flags(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return osquery_flags information from osquery
CLI Example:
@ -1173,8 +1043,6 @@ def osquery_flags(attrs=None, where=None):
def osquery_info(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return osquery_info information from osquery
CLI Example:
@ -1188,8 +1056,6 @@ def osquery_info(attrs=None, where=None):
def osquery_registry(attrs=None, where=None):
'''
.. versionadded:: Beryllium
Return osquery_registry information from osquery
CLI Example:
@ -1203,8 +1069,6 @@ def osquery_registry(attrs=None, where=None):
def time_(attrs=None):
'''
.. versionadded:: Beryllium
Return time information from osquery
CLI Example:
@ -1218,8 +1082,6 @@ def time_(attrs=None):
def query(sql=None):
'''
.. versionadded:: Beryllium
Return time information from osquery
CLI Example:

6
salt/modules/pillar.py
View file

@ -136,7 +136,7 @@ def _obfuscate_inner(var):
def obfuscate(*args):
'''
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Same as :py:func:`items`, but replace pillar values with a simple type indication.
@ -168,7 +168,7 @@ def obfuscate(*args):
# identifier rule.
def ls(*args):
'''
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Calls the master for a fresh pillar, generates the pillar data on the
fly (same as :py:func:`items`), but only shows the available main keys.
@ -281,7 +281,7 @@ def ext(external, pillar=None):
def keys(key, delimiter=DEFAULT_TARGET_DELIM):
'''
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Attempt to retrieve a list of keys from the named value from the pillar.

2
salt/modules/pkg_resource.py
View file

@ -55,7 +55,7 @@ def pack_sources(sources, normalize=True):
part of the name, such as kernel modules which match a specific kernel
version.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:

46
salt/modules/portage_config.py
View file

@ -526,14 +526,16 @@ def is_present(conf, atom):
def get_iuse(cp):
"""
.. versionadded:: Beryllium
Gets the current IUSE flags from the tree
'''
.. versionadded:: 2015.8.0
Gets the current IUSE flags from the tree.
@type: cpv: string
@param cpv: cat/pkg
@rtype list
@returns [] or the list of IUSE flags
"""
'''
cpv = _get_cpv(cp)
try:
# aux_get might return dupes, so run them through set() to remove them
@ -544,24 +546,27 @@ def get_iuse(cp):
def get_installed_use(cp, use="USE"):
"""
.. versionadded:: Beryllium
Gets the installed USE flags from the VARDB
'''
.. versionadded:: 2015.8.0
Gets the installed USE flags from the VARDB.
@type: cp: string
@param cp: cat/pkg
@type use: string
@param use: 1 of ["USE", "PKGUSE"]
@rtype list
@returns [] or the list of IUSE flags
"""
'''
portage = _get_portage()
cpv = _get_cpv(cp)
return portage.db[portage.root]["vartree"].dbapi.aux_get(cpv, [use])[0].split()
def filter_flags(use, use_expand_hidden, usemasked, useforced):
"""
.. versionadded:: Beryllium
'''
.. versionadded:: 2015.8.0
Filter function to remove hidden or otherwise not normally
visible USE flags from a list.
@ -575,7 +580,7 @@ def filter_flags(use, use_expand_hidden, usemasked, useforced):
@param useforced: the forced USE flags.
@rtype: list
@return the filtered USE flags.
"""
'''
portage = _get_portage()
# clean out some environment flags, since they will most probably
# be confusing for the user
@ -598,15 +603,16 @@ def filter_flags(use, use_expand_hidden, usemasked, useforced):
def get_all_cpv_use(cp):
"""
.. versionadded:: Beryllium
Uses portage to determine final USE flags and settings for an emerge
'''
.. versionadded:: 2015.8.0
Uses portage to determine final USE flags and settings for an emerge.
@type cp: string
@param cp: eg cat/pkg
@rtype: lists
@return use, use_expand_hidden, usemask, useforce
"""
'''
cpv = _get_cpv(cp)
portage = _get_portage()
use = None
@ -629,9 +635,11 @@ def get_all_cpv_use(cp):
def get_cleared_flags(cp):
'''
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Uses portage for compare use flags which is used for installing package
and use flags which now exist int /etc/portage/package.use/
@type cp: string
@param cp: eg cat/pkg
@rtype: tuple
@ -649,9 +657,11 @@ def get_cleared_flags(cp):
def is_changed_uses(cp):
'''
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Uses portage for determine if the use flags of installed package
is compatible with use flags in portage configs
is compatible with use flags in portage configs.
@type cp: string
@param cp: eg cat/pkg
'''

27
salt/modules/postgres.py
View file

@ -473,10 +473,14 @@ def tablespace_list(user=None, host=None, port=None, maintenance_db=None,
password=None, runas=None):
'''
Return dictionary with information about tablespaces of a Postgres server.
CLI Example:
.. code-block:: bash
salt '*' postgres.tablespace_list
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
'''
ret = {}
@ -503,10 +507,14 @@ def tablespace_exists(name, user=None, host=None, port=None, maintenance_db=None
password=None, runas=None):
'''
Checks if a tablespace exists on the Postgres server.
CLI Example:
.. code-block:: bash
salt '*' postgres.tablespace_exists 'dbname'
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
'''
tablespaces = tablespace_list(user=user, host=host, port=port,
@ -526,7 +534,8 @@ def tablespace_create(name, location, options=None, owner=None, user=None,
.. code-block:: bash
salt '*' postgres.tablespace_create tablespacename '/path/datadir'
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
'''
owner_query = ''
options_query = ''
@ -555,13 +564,17 @@ def tablespace_alter(name, user=None, host=None, port=None, maintenance_db=None,
set_option=None, reset_option=None, runas=None):
'''
Change tablespace name, owner, or options.
CLI Example:
.. code-block:: bash
salt '*' postgres.tablespace_alter tsname new_owner=otheruser
salt '*' postgres.tablespace_alter index_space new_name=fast_raid
salt '*' postgres.tablespace_alter test set_option="{'seq_page_cost': '1.1'}"
salt '*' postgres.tablespace_alter tsname reset_option=seq_page_cost
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
'''
if not any([new_name, new_owner, set_option, reset_option]):
return True # Nothing todo?
@ -596,10 +609,14 @@ def tablespace_remove(name, user=None, host=None, port=None,
maintenance_db=None, password=None, runas=None):
'''
Removes a tablespace from the Postgres server.
CLI Example:
.. code-block:: bash
salt '*' postgres.tablespace_remove tsname
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
'''
query = 'DROP TABLESPACE {0}'.format(name)
ret = _psql_prepare_and_run(['-c', query],

6
salt/modules/rallydev.py
View file

@ -2,7 +2,7 @@
'''
Support for RallyDev
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Requires a ``username`` and a ``password`` in ``/etc/salt/minion``:
@ -68,9 +68,7 @@ def _query(action=None,
header_dict=None,
data=None):
'''
Make a web call to Stormpath
.. versionadded:: Beryllium
Make a web call to RallyDev.
'''
token = _get_token()
username = __opts__.get('rallydev', {}).get('username', None)

18
salt/modules/riak.py
View file

@ -53,7 +53,7 @@ def stop():
'''
Stop Riak
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
CLI Example:
@ -78,7 +78,7 @@ def cluster_join(username, hostname):
'''
Join a Riak cluster
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
CLI Example:
@ -108,7 +108,7 @@ def cluster_leave(username, hostname):
'''
Leave a Riak cluster
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -138,7 +138,7 @@ def cluster_plan():
'''
Review Cluster Plan
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
CLI Example:
@ -158,7 +158,7 @@ def cluster_commit():
'''
Commit Cluster Changes
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
CLI Example:
@ -183,7 +183,7 @@ def member_status():
'''
Get cluster member status
.. versionchanged:: Beryllium
.. versionchanged:: 2015.8.0
CLI Example:
@ -227,7 +227,7 @@ def status():
'''
Current node status
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -251,7 +251,7 @@ def test():
'''
Runs a test of a few standard Riak operations
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -276,7 +276,7 @@ def services():
'''
List available services on a node
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:

2
salt/modules/rpm.py
View file

@ -46,7 +46,7 @@ def __virtual__():
def bin_pkg_info(path, saltenv='base'):
'''
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Parses RPM metadata and returns a dictionary of information about the
package (name, version, etc.).

2
salt/modules/rpmbuild.py
View file

@ -2,7 +2,7 @@
'''
RPM Package builder system
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
This system allows for all of the components to build rpms safely in chrooted
environments. This also provides a function to generate yum repositories

2
salt/modules/saltutil.py
View file

@ -423,7 +423,7 @@ def sync_utils(saltenv=None, refresh=True):
def sync_log_handlers(saltenv=None, refresh=True):
'''
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Sync utility source files from the _log_handlers directory on the salt master file
server. This function is environment aware, pass the desired environment

15
salt/modules/stormpath.py
View file

@ -2,7 +2,7 @@
'''
Support for Stormpath
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
'''
# Import python libs
@ -35,7 +35,6 @@ def create_account(directory_id, email, password, givenName, surname, **kwargs):
salt myminion stormpath.create_account <directory_id> shemp@example.com letmein Shemp Howard
.. versionadded:: Beryllium
'''
items = {
'email': email,
@ -65,7 +64,6 @@ def list_accounts():
salt myminion stormpath.list_accounts
.. versionadded:: Beryllium
'''
status, result = _query(action='accounts', command='current')
return result
@ -84,7 +82,6 @@ def show_account(account_id=None,
salt myminion stormpath.show_account <account_id>
.. versionadded:: Beryllium
'''
if account_id:
status, result = _query(
@ -130,7 +127,6 @@ def update_account(account_id, key=None, value=None, items=None):
salt myminion stormpath.update_account <account_id> items='{"givenName": "Shemp"}
salt myminion stormpath.update_account <account_id> items='{"middlename": ""}
.. versionadded:: Beryllium
'''
if items is None:
if key is None or value is None:
@ -150,7 +146,7 @@ def update_account(account_id, key=None, value=None, items=None):
def delete_account(account_id):
'''
Delete an account
Delete an account.
CLI Examples:
@ -173,7 +169,6 @@ def list_directories():
salt myminion stormpath.list_directories
.. versionadded:: Beryllium
'''
tenant = show_tenant()
tenant_id = tenant.get('href', '').split('/')[-1]
@ -183,7 +178,7 @@ def list_directories():
def show_tenant():
'''
Get the tenant for the login being used
Get the tenant for the login being used.
'''
status, result = _query(action='tenants', command='current')
return result
@ -196,9 +191,7 @@ def _query(action=None,
header_dict=None,
data=None):
'''
Make a web call to Stormpath
.. versionadded:: Beryllium
Make a web call to Stormpath.
'''
apiid = __opts__.get('stormpath', {}).get('apiid', None)
apikey = __opts__.get('stormpath', {}).get('apikey', None)

2
salt/modules/temp.py
View file

@ -4,7 +4,7 @@ Simple module for creating temporary directories and files
This is a thin wrapper around Pythons tempfile module
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
'''
from __future__ import absolute_import

8
salt/modules/tls.py
View file

@ -741,7 +741,7 @@ def get_extensions(cert_type):
Fetch X509 and CSR extension definitions from tls:extensions:
(common|server|client) or set them to standard defaults.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
cert_type:
The type of certificate such as ``server`` or ``client``.
@ -882,7 +882,7 @@ def create_csr(ca_name,
requests to https://1.2.3.4 will fail from python's
requests library w/out the second entry in the above list
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
cert_type
Specify the general certificate type. Can be either `server` or
@ -1563,7 +1563,7 @@ def create_empty_crl(
'''
Create an empty Certificate Revocation List.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
ca_name
name of the CA
@ -1639,7 +1639,7 @@ def revoke_cert(
'''
Revoke a certificate.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
ca_name
Name of the CA.

2
salt/modules/udev.py
View file

@ -2,7 +2,7 @@
'''
Manage and query udev info
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
'''
from __future__ import absolute_import

2
salt/modules/win_service.py
View file

@ -393,7 +393,7 @@ def create(name,
'''
Create the named service.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Required parameters:
name: Specifies the service name returned by the getkeyname operation

10
salt/modules/win_status.py
View file

@ -56,7 +56,7 @@ def __virtual__():
def cpuload():
'''
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Return the processor load as a percentage
@ -83,7 +83,7 @@ def cpuload():
def diskusage(human_readable=False, path=None):
'''
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Return the disk usage for this minion
@ -131,7 +131,7 @@ def procs(count=False):
count : False
If ``True``, this function will simply return the number of processes.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -158,7 +158,7 @@ def procs(count=False):
def saltmem(human_readable=False):
'''
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Returns the amount of memory that salt is using
@ -186,7 +186,7 @@ def saltmem(human_readable=False):
def uptime(human_readable=False):
'''
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
Return the system uptime for this machine in seconds

8
salt/modules/win_system.py
View file

@ -50,7 +50,7 @@ def halt(timeout=5, in_seconds=False):
in_seconds
Whether to treat timeout as seconds or minutes.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -91,7 +91,7 @@ def poweroff(timeout=5, in_seconds=False):
in_seconds
Whether to treat timeout as seconds or minutes.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -112,7 +112,7 @@ def reboot(timeout=5, in_seconds=False):
in_seconds
Whether to treat timeout as seconds or minutes.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example:
@ -136,7 +136,7 @@ def shutdown(timeout=5, in_seconds=False):
in_seconds
Whether to treat timeout as seconds or minutes.
.. versionadded:: Beryllium
.. versionadded:: 2015.8.0
CLI Example: