repo
stringclasses
85 values
path
stringlengths
8
121
func_name
stringlengths
1
82
original_string
stringlengths
112
65.5k
language
stringclasses
1 value
code
stringlengths
112
65.5k
code_tokens
listlengths
20
4.09k
docstring
stringlengths
3
46.3k
docstring_tokens
listlengths
1
564
sha
stringclasses
85 values
url
stringlengths
93
218
partition
stringclasses
1 value
saltstack/salt
salt/states/boto3_elasticache.py
cache_subnet_group_present
def cache_subnet_group_present(name, subnets=None, region=None, key=None, keyid=None, profile=None, **args): ''' Ensure cache subnet group exists. name A name for the cache subnet group. This value is stored as a lowercase string. Constraints: Must contain no...
python
def cache_subnet_group_present(name, subnets=None, region=None, key=None, keyid=None, profile=None, **args): ''' Ensure cache subnet group exists. name A name for the cache subnet group. This value is stored as a lowercase string. Constraints: Must contain no...
[ "def", "cache_subnet_group_present", "(", "name", ",", "subnets", "=", "None", ",", "region", "=", "None", ",", "key", "=", "None", ",", "keyid", "=", "None", ",", "profile", "=", "None", ",", "*", "*", "args", ")", ":", "ret", "=", "{", "'name'", ...
Ensure cache subnet group exists. name A name for the cache subnet group. This value is stored as a lowercase string. Constraints: Must contain no more than 255 alphanumeric characters or hyphens. subnets A list of VPC subnets (IDs, Names, or a mix) for the cache subnet group. Ca...
[ "Ensure", "cache", "subnet", "group", "exists", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/boto3_elasticache.py#L1014-L1101
train
saltstack/salt
salt/states/boto3_elasticache.py
cache_subnet_group_absent
def cache_subnet_group_absent(name, region=None, key=None, keyid=None, profile=None, **args): ''' Ensure a given cache subnet group is deleted. name Name of the cache subnet group. CacheSubnetGroupName A name for the cache subnet group. Note: In general this parameter is not n...
python
def cache_subnet_group_absent(name, region=None, key=None, keyid=None, profile=None, **args): ''' Ensure a given cache subnet group is deleted. name Name of the cache subnet group. CacheSubnetGroupName A name for the cache subnet group. Note: In general this parameter is not n...
[ "def", "cache_subnet_group_absent", "(", "name", ",", "region", "=", "None", ",", "key", "=", "None", ",", "keyid", "=", "None", ",", "profile", "=", "None", ",", "*", "*", "args", ")", ":", "ret", "=", "{", "'name'", ":", "name", ",", "'result'", ...
Ensure a given cache subnet group is deleted. name Name of the cache subnet group. CacheSubnetGroupName A name for the cache subnet group. Note: In general this parameter is not needed, as 'name' is used if it's not provided. region Region to connect to. key ...
[ "Ensure", "a", "given", "cache", "subnet", "group", "is", "deleted", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/boto3_elasticache.py#L1104-L1149
train
saltstack/salt
salt/states/boto3_elasticache.py
cache_parameter_group_present
def cache_parameter_group_present(name, region=None, key=None, keyid=None, profile=None, **args): ''' Ensure cache parameter group exists. name A name for the cache parameter group. CacheParameterGroupName A name for the cache parameter group. Note: In general this parameter i...
python
def cache_parameter_group_present(name, region=None, key=None, keyid=None, profile=None, **args): ''' Ensure cache parameter group exists. name A name for the cache parameter group. CacheParameterGroupName A name for the cache parameter group. Note: In general this parameter i...
[ "def", "cache_parameter_group_present", "(", "name", ",", "region", "=", "None", ",", "key", "=", "None", ",", "keyid", "=", "None", ",", "profile", "=", "None", ",", "*", "*", "args", ")", ":", "ret", "=", "{", "'name'", ":", "name", ",", "'result'"...
Ensure cache parameter group exists. name A name for the cache parameter group. CacheParameterGroupName A name for the cache parameter group. Note: In general this parameter is not needed, as 'name' is used if it's not provided. CacheParameterGroupFamily The name of the ...
[ "Ensure", "cache", "parameter", "group", "exists", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/boto3_elasticache.py#L1152-L1277
train
saltstack/salt
salt/modules/boto_cognitoidentity.py
_find_identity_pool_ids
def _find_identity_pool_ids(name, pool_id, conn): ''' Given identity pool name (or optionally a pool_id and name will be ignored), find and return list of matching identity pool id's. ''' ids = [] if pool_id is None: for pools in __utils__['boto3.paged_call'](conn.list_identity_pools, ...
python
def _find_identity_pool_ids(name, pool_id, conn): ''' Given identity pool name (or optionally a pool_id and name will be ignored), find and return list of matching identity pool id's. ''' ids = [] if pool_id is None: for pools in __utils__['boto3.paged_call'](conn.list_identity_pools, ...
[ "def", "_find_identity_pool_ids", "(", "name", ",", "pool_id", ",", "conn", ")", ":", "ids", "=", "[", "]", "if", "pool_id", "is", "None", ":", "for", "pools", "in", "__utils__", "[", "'boto3.paged_call'", "]", "(", "conn", ".", "list_identity_pools", ",",...
Given identity pool name (or optionally a pool_id and name will be ignored), find and return list of matching identity pool id's.
[ "Given", "identity", "pool", "name", "(", "or", "optionally", "a", "pool_id", "and", "name", "will", "be", "ignored", ")", "find", "and", "return", "list", "of", "matching", "identity", "pool", "id", "s", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/boto_cognitoidentity.py#L126-L141
train
saltstack/salt
salt/modules/boto_cognitoidentity.py
describe_identity_pools
def describe_identity_pools(IdentityPoolName, IdentityPoolId=None, region=None, key=None, keyid=None, profile=None): ''' Given an identity pool name, (optionally if an identity pool id is given, the given name will be ignored) Returns a list of matched identity pool name's pool properti...
python
def describe_identity_pools(IdentityPoolName, IdentityPoolId=None, region=None, key=None, keyid=None, profile=None): ''' Given an identity pool name, (optionally if an identity pool id is given, the given name will be ignored) Returns a list of matched identity pool name's pool properti...
[ "def", "describe_identity_pools", "(", "IdentityPoolName", ",", "IdentityPoolId", "=", "None", ",", "region", "=", "None", ",", "key", "=", "None", ",", "keyid", "=", "None", ",", "profile", "=", "None", ")", ":", "conn", "=", "_get_conn", "(", "region", ...
Given an identity pool name, (optionally if an identity pool id is given, the given name will be ignored) Returns a list of matched identity pool name's pool properties CLI Example: .. code-block:: bash salt myminion boto_cognitoidentity.describe_identity_pools my_id_pool_name salt m...
[ "Given", "an", "identity", "pool", "name", "(", "optionally", "if", "an", "identity", "pool", "id", "is", "given", "the", "given", "name", "will", "be", "ignored", ")" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/boto_cognitoidentity.py#L144-L176
train
saltstack/salt
salt/modules/boto_cognitoidentity.py
create_identity_pool
def create_identity_pool(IdentityPoolName, AllowUnauthenticatedIdentities=False, SupportedLoginProviders=None, DeveloperProviderName=None, OpenIdConnectProviderARNs=None, region=None, key=None, k...
python
def create_identity_pool(IdentityPoolName, AllowUnauthenticatedIdentities=False, SupportedLoginProviders=None, DeveloperProviderName=None, OpenIdConnectProviderARNs=None, region=None, key=None, k...
[ "def", "create_identity_pool", "(", "IdentityPoolName", ",", "AllowUnauthenticatedIdentities", "=", "False", ",", "SupportedLoginProviders", "=", "None", ",", "DeveloperProviderName", "=", "None", ",", "OpenIdConnectProviderARNs", "=", "None", ",", "region", "=", "None"...
Creates a new identity pool. All parameters except for IdentityPoolName is optional. SupportedLoginProviders should be a dictionary mapping provider names to provider app IDs. OpenIdConnectProviderARNs should be a list of OpenID Connect provider ARNs. Returns the created identity pool if successful ...
[ "Creates", "a", "new", "identity", "pool", ".", "All", "parameters", "except", "for", "IdentityPoolName", "is", "optional", ".", "SupportedLoginProviders", "should", "be", "a", "dictionary", "mapping", "provider", "names", "to", "provider", "app", "IDs", ".", "O...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/boto_cognitoidentity.py#L179-L218
train
saltstack/salt
salt/modules/boto_cognitoidentity.py
delete_identity_pools
def delete_identity_pools(IdentityPoolName, IdentityPoolId=None, region=None, key=None, keyid=None, profile=None): ''' Given an identity pool name, (optionally if an identity pool id is given, the given name will be ignored) Deletes all identity pools matching the given name, or the spec...
python
def delete_identity_pools(IdentityPoolName, IdentityPoolId=None, region=None, key=None, keyid=None, profile=None): ''' Given an identity pool name, (optionally if an identity pool id is given, the given name will be ignored) Deletes all identity pools matching the given name, or the spec...
[ "def", "delete_identity_pools", "(", "IdentityPoolName", ",", "IdentityPoolId", "=", "None", ",", "region", "=", "None", ",", "key", "=", "None", ",", "keyid", "=", "None", ",", "profile", "=", "None", ")", ":", "conn", "=", "_get_conn", "(", "region", "...
Given an identity pool name, (optionally if an identity pool id is given, the given name will be ignored) Deletes all identity pools matching the given name, or the specific identity pool with the given identity pool id. CLI Example: .. code-block:: bash salt myminion boto_cognitoidentit...
[ "Given", "an", "identity", "pool", "name", "(", "optionally", "if", "an", "identity", "pool", "id", "is", "given", "the", "given", "name", "will", "be", "ignored", ")" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/boto_cognitoidentity.py#L221-L252
train
saltstack/salt
salt/modules/boto_cognitoidentity.py
_get_role_arn
def _get_role_arn(name, **conn_params): ''' Helper function to turn a name into an arn string, returns None if not able to resolve ''' if name.startswith('arn:aws:iam'): return name role = __salt__['boto_iam.describe_role'](name, **conn_params) rolearn = role.get('arn') if role else ...
python
def _get_role_arn(name, **conn_params): ''' Helper function to turn a name into an arn string, returns None if not able to resolve ''' if name.startswith('arn:aws:iam'): return name role = __salt__['boto_iam.describe_role'](name, **conn_params) rolearn = role.get('arn') if role else ...
[ "def", "_get_role_arn", "(", "name", ",", "*", "*", "conn_params", ")", ":", "if", "name", ".", "startswith", "(", "'arn:aws:iam'", ")", ":", "return", "name", "role", "=", "__salt__", "[", "'boto_iam.describe_role'", "]", "(", "name", ",", "*", "*", "co...
Helper function to turn a name into an arn string, returns None if not able to resolve
[ "Helper", "function", "to", "turn", "a", "name", "into", "an", "arn", "string", "returns", "None", "if", "not", "able", "to", "resolve" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/boto_cognitoidentity.py#L289-L299
train
saltstack/salt
salt/modules/boto_cognitoidentity.py
set_identity_pool_roles
def set_identity_pool_roles(IdentityPoolId, AuthenticatedRole=None, UnauthenticatedRole=None, region=None, key=None, keyid=None, profile=None): ''' Given an identity pool id, set the given AuthenticatedRole and UnauthenticatedRole (the Role can be an iam arn, or a role name) If AuthenticatedRole or...
python
def set_identity_pool_roles(IdentityPoolId, AuthenticatedRole=None, UnauthenticatedRole=None, region=None, key=None, keyid=None, profile=None): ''' Given an identity pool id, set the given AuthenticatedRole and UnauthenticatedRole (the Role can be an iam arn, or a role name) If AuthenticatedRole or...
[ "def", "set_identity_pool_roles", "(", "IdentityPoolId", ",", "AuthenticatedRole", "=", "None", ",", "UnauthenticatedRole", "=", "None", ",", "region", "=", "None", ",", "key", "=", "None", ",", "keyid", "=", "None", ",", "profile", "=", "None", ")", ":", ...
Given an identity pool id, set the given AuthenticatedRole and UnauthenticatedRole (the Role can be an iam arn, or a role name) If AuthenticatedRole or UnauthenticatedRole is not given, the authenticated and/or the unauthenticated role associated previously with the pool will be cleared. Returns set T...
[ "Given", "an", "identity", "pool", "id", "set", "the", "given", "AuthenticatedRole", "and", "UnauthenticatedRole", "(", "the", "Role", "can", "be", "an", "iam", "arn", "or", "a", "role", "name", ")", "If", "AuthenticatedRole", "or", "UnauthenticatedRole", "is"...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/boto_cognitoidentity.py#L302-L351
train
saltstack/salt
salt/modules/boto_cognitoidentity.py
update_identity_pool
def update_identity_pool(IdentityPoolId, IdentityPoolName=None, AllowUnauthenticatedIdentities=False, SupportedLoginProviders=None, DeveloperProviderName=None, OpenIdConnectProviderARNs=None, ...
python
def update_identity_pool(IdentityPoolId, IdentityPoolName=None, AllowUnauthenticatedIdentities=False, SupportedLoginProviders=None, DeveloperProviderName=None, OpenIdConnectProviderARNs=None, ...
[ "def", "update_identity_pool", "(", "IdentityPoolId", ",", "IdentityPoolName", "=", "None", ",", "AllowUnauthenticatedIdentities", "=", "False", ",", "SupportedLoginProviders", "=", "None", ",", "DeveloperProviderName", "=", "None", ",", "OpenIdConnectProviderARNs", "=", ...
Updates the given IdentityPoolId's properties. All parameters except for IdentityPoolId, is optional. SupportedLoginProviders should be a dictionary mapping provider names to provider app IDs. OpenIdConnectProviderARNs should be a list of OpenID Connect provider ARNs. To clear SupportedLoginProvider...
[ "Updates", "the", "given", "IdentityPoolId", "s", "properties", ".", "All", "parameters", "except", "for", "IdentityPoolId", "is", "optional", ".", "SupportedLoginProviders", "should", "be", "a", "dictionary", "mapping", "provider", "names", "to", "provider", "app",...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/boto_cognitoidentity.py#L354-L422
train
saltstack/salt
salt/modules/state.py
_filter_running
def _filter_running(runnings): ''' Filter out the result: True + no changes data ''' ret = dict((tag, value) for tag, value in six.iteritems(runnings) if not value['result'] or value['changes']) return ret
python
def _filter_running(runnings): ''' Filter out the result: True + no changes data ''' ret = dict((tag, value) for tag, value in six.iteritems(runnings) if not value['result'] or value['changes']) return ret
[ "def", "_filter_running", "(", "runnings", ")", ":", "ret", "=", "dict", "(", "(", "tag", ",", "value", ")", "for", "tag", ",", "value", "in", "six", ".", "iteritems", "(", "runnings", ")", "if", "not", "value", "[", "'result'", "]", "or", "value", ...
Filter out the result: True + no changes data
[ "Filter", "out", "the", "result", ":", "True", "+", "no", "changes", "data" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L87-L93
train
saltstack/salt
salt/modules/state.py
_set_retcode
def _set_retcode(ret, highstate=None): ''' Set the return code based on the data back from the state system ''' # Set default retcode to 0 __context__['retcode'] = salt.defaults.exitcodes.EX_OK if isinstance(ret, list): __context__['retcode'] = salt.defaults.exitcodes.EX_STATE_COMPILER...
python
def _set_retcode(ret, highstate=None): ''' Set the return code based on the data back from the state system ''' # Set default retcode to 0 __context__['retcode'] = salt.defaults.exitcodes.EX_OK if isinstance(ret, list): __context__['retcode'] = salt.defaults.exitcodes.EX_STATE_COMPILER...
[ "def", "_set_retcode", "(", "ret", ",", "highstate", "=", "None", ")", ":", "# Set default retcode to 0", "__context__", "[", "'retcode'", "]", "=", "salt", ".", "defaults", ".", "exitcodes", ".", "EX_OK", "if", "isinstance", "(", "ret", ",", "list", ")", ...
Set the return code based on the data back from the state system
[ "Set", "the", "return", "code", "based", "on", "the", "data", "back", "from", "the", "state", "system" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L96-L108
train
saltstack/salt
salt/modules/state.py
_snapper_pre
def _snapper_pre(opts, jid): ''' Create a snapper pre snapshot ''' snapper_pre = None try: if not opts['test'] and __opts__.get('snapper_states'): # Run the snapper pre snapshot snapper_pre = __salt__['snapper.create_snapshot']( config=__opts__.get...
python
def _snapper_pre(opts, jid): ''' Create a snapper pre snapshot ''' snapper_pre = None try: if not opts['test'] and __opts__.get('snapper_states'): # Run the snapper pre snapshot snapper_pre = __salt__['snapper.create_snapshot']( config=__opts__.get...
[ "def", "_snapper_pre", "(", "opts", ",", "jid", ")", ":", "snapper_pre", "=", "None", "try", ":", "if", "not", "opts", "[", "'test'", "]", "and", "__opts__", ".", "get", "(", "'snapper_states'", ")", ":", "# Run the snapper pre snapshot", "snapper_pre", "=",...
Create a snapper pre snapshot
[ "Create", "a", "snapper", "pre", "snapshot" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L135-L150
train
saltstack/salt
salt/modules/state.py
_snapper_post
def _snapper_post(opts, jid, pre_num): ''' Create the post states snapshot ''' try: if not opts['test'] and __opts__.get('snapper_states') and pre_num: # Run the snapper pre snapshot __salt__['snapper.create_snapshot']( config=__opts__.get('snapper_sta...
python
def _snapper_post(opts, jid, pre_num): ''' Create the post states snapshot ''' try: if not opts['test'] and __opts__.get('snapper_states') and pre_num: # Run the snapper pre snapshot __salt__['snapper.create_snapshot']( config=__opts__.get('snapper_sta...
[ "def", "_snapper_post", "(", "opts", ",", "jid", ",", "pre_num", ")", ":", "try", ":", "if", "not", "opts", "[", "'test'", "]", "and", "__opts__", ".", "get", "(", "'snapper_states'", ")", "and", "pre_num", ":", "# Run the snapper pre snapshot", "__salt__", ...
Create the post states snapshot
[ "Create", "the", "post", "states", "snapshot" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L153-L167
train
saltstack/salt
salt/modules/state.py
_get_pause
def _get_pause(jid, state_id=None): ''' Return the pause information for a given jid ''' pause_dir = os.path.join(__opts__['cachedir'], 'state_pause') pause_path = os.path.join(pause_dir, jid) if not os.path.exists(pause_dir): try: os.makedirs(pause_dir) except OSErro...
python
def _get_pause(jid, state_id=None): ''' Return the pause information for a given jid ''' pause_dir = os.path.join(__opts__['cachedir'], 'state_pause') pause_path = os.path.join(pause_dir, jid) if not os.path.exists(pause_dir): try: os.makedirs(pause_dir) except OSErro...
[ "def", "_get_pause", "(", "jid", ",", "state_id", "=", "None", ")", ":", "pause_dir", "=", "os", ".", "path", ".", "join", "(", "__opts__", "[", "'cachedir'", "]", ",", "'state_pause'", ")", "pause_path", "=", "os", ".", "path", ".", "join", "(", "pa...
Return the pause information for a given jid
[ "Return", "the", "pause", "information", "for", "a", "given", "jid" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L170-L189
train
saltstack/salt
salt/modules/state.py
get_pauses
def get_pauses(jid=None): ''' Get a report on all of the currently paused state runs and pause run settings. Optionally send in a jid if you only desire to see a single pause data set. ''' ret = {} active = __salt__['saltutil.is_running']('state.*') pause_dir = os.path.join(__opts__[...
python
def get_pauses(jid=None): ''' Get a report on all of the currently paused state runs and pause run settings. Optionally send in a jid if you only desire to see a single pause data set. ''' ret = {} active = __salt__['saltutil.is_running']('state.*') pause_dir = os.path.join(__opts__[...
[ "def", "get_pauses", "(", "jid", "=", "None", ")", ":", "ret", "=", "{", "}", "active", "=", "__salt__", "[", "'saltutil.is_running'", "]", "(", "'state.*'", ")", "pause_dir", "=", "os", ".", "path", ".", "join", "(", "__opts__", "[", "'cachedir'", "]"...
Get a report on all of the currently paused state runs and pause run settings. Optionally send in a jid if you only desire to see a single pause data set.
[ "Get", "a", "report", "on", "all", "of", "the", "currently", "paused", "state", "runs", "and", "pause", "run", "settings", ".", "Optionally", "send", "in", "a", "jid", "if", "you", "only", "desire", "to", "see", "a", "single", "pause", "data", "set", "...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L192-L225
train
saltstack/salt
salt/modules/state.py
soft_kill
def soft_kill(jid, state_id=None): ''' Set up a state run to die before executing the given state id, this instructs a running state to safely exit at a given state id. This needs to pass in the jid of the running state. If a state_id is not passed then the jid referenced will be safely exited a...
python
def soft_kill(jid, state_id=None): ''' Set up a state run to die before executing the given state id, this instructs a running state to safely exit at a given state id. This needs to pass in the jid of the running state. If a state_id is not passed then the jid referenced will be safely exited a...
[ "def", "soft_kill", "(", "jid", ",", "state_id", "=", "None", ")", ":", "jid", "=", "six", ".", "text_type", "(", "jid", ")", "if", "state_id", "is", "None", ":", "state_id", "=", "'__all__'", "data", ",", "pause_path", "=", "_get_pause", "(", "jid", ...
Set up a state run to die before executing the given state id, this instructs a running state to safely exit at a given state id. This needs to pass in the jid of the running state. If a state_id is not passed then the jid referenced will be safely exited at the beginning of the next state run. The...
[ "Set", "up", "a", "state", "run", "to", "die", "before", "executing", "the", "given", "state", "id", "this", "instructs", "a", "running", "state", "to", "safely", "exit", "at", "a", "given", "state", "id", ".", "This", "needs", "to", "pass", "in", "the...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L228-L259
train
saltstack/salt
salt/modules/state.py
pause
def pause(jid, state_id=None, duration=None): ''' Set up a state id pause, this instructs a running state to pause at a given state id. This needs to pass in the jid of the running state and can optionally pass in a duration in seconds. If a state_id is not passed then the jid referenced will be pau...
python
def pause(jid, state_id=None, duration=None): ''' Set up a state id pause, this instructs a running state to pause at a given state id. This needs to pass in the jid of the running state and can optionally pass in a duration in seconds. If a state_id is not passed then the jid referenced will be pau...
[ "def", "pause", "(", "jid", ",", "state_id", "=", "None", ",", "duration", "=", "None", ")", ":", "jid", "=", "six", ".", "text_type", "(", "jid", ")", "if", "state_id", "is", "None", ":", "state_id", "=", "'__all__'", "data", ",", "pause_path", "=",...
Set up a state id pause, this instructs a running state to pause at a given state id. This needs to pass in the jid of the running state and can optionally pass in a duration in seconds. If a state_id is not passed then the jid referenced will be paused at the beginning of the next state run. The given...
[ "Set", "up", "a", "state", "id", "pause", "this", "instructs", "a", "running", "state", "to", "pause", "at", "a", "given", "state", "id", ".", "This", "needs", "to", "pass", "in", "the", "jid", "of", "the", "running", "state", "and", "can", "optionally...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L262-L294
train
saltstack/salt
salt/modules/state.py
resume
def resume(jid, state_id=None): ''' Remove a pause from a jid, allowing it to continue. If the state_id is not specified then the a general pause will be resumed. The given state_id is the id got a given state execution, so given a state that looks like this: .. code-block:: yaml vim:...
python
def resume(jid, state_id=None): ''' Remove a pause from a jid, allowing it to continue. If the state_id is not specified then the a general pause will be resumed. The given state_id is the id got a given state execution, so given a state that looks like this: .. code-block:: yaml vim:...
[ "def", "resume", "(", "jid", ",", "state_id", "=", "None", ")", ":", "jid", "=", "six", ".", "text_type", "(", "jid", ")", "if", "state_id", "is", "None", ":", "state_id", "=", "'__all__'", "data", ",", "pause_path", "=", "_get_pause", "(", "jid", ",...
Remove a pause from a jid, allowing it to continue. If the state_id is not specified then the a general pause will be resumed. The given state_id is the id got a given state execution, so given a state that looks like this: .. code-block:: yaml vim: pkg.installed: [] The state_...
[ "Remove", "a", "pause", "from", "a", "jid", "allowing", "it", "to", "continue", ".", "If", "the", "state_id", "is", "not", "specified", "then", "the", "a", "general", "pause", "will", "be", "resumed", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L297-L328
train
saltstack/salt
salt/modules/state.py
orchestrate
def orchestrate(mods, saltenv='base', test=None, exclude=None, pillar=None, pillarenv=None): ''' .. versionadded:: 2016.11.0 Execute the orchestrate runner from a masterless minion. .. seealso:: More Orchestrate documentat...
python
def orchestrate(mods, saltenv='base', test=None, exclude=None, pillar=None, pillarenv=None): ''' .. versionadded:: 2016.11.0 Execute the orchestrate runner from a masterless minion. .. seealso:: More Orchestrate documentat...
[ "def", "orchestrate", "(", "mods", ",", "saltenv", "=", "'base'", ",", "test", "=", "None", ",", "exclude", "=", "None", ",", "pillar", "=", "None", ",", "pillarenv", "=", "None", ")", ":", "return", "_orchestrate", "(", "mods", "=", "mods", ",", "sa...
.. versionadded:: 2016.11.0 Execute the orchestrate runner from a masterless minion. .. seealso:: More Orchestrate documentation * :ref:`Full Orchestrate Tutorial <orchestrate-runner>` * :py:mod:`Docs for the ``salt`` state module <salt.states.saltmod>` CLI Examples: .. code-block::...
[ "..", "versionadded", "::", "2016", ".", "11", ".", "0" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L331-L360
train
saltstack/salt
salt/modules/state.py
_check_queue
def _check_queue(queue, kwargs): ''' Utility function to queue the state run if requested and to check for conflicts in currently running states ''' if queue: _wait(kwargs.get('__pub_jid')) else: conflict = running(concurrent=kwargs.get('concurrent', False)) if conflict: ...
python
def _check_queue(queue, kwargs): ''' Utility function to queue the state run if requested and to check for conflicts in currently running states ''' if queue: _wait(kwargs.get('__pub_jid')) else: conflict = running(concurrent=kwargs.get('concurrent', False)) if conflict: ...
[ "def", "_check_queue", "(", "queue", ",", "kwargs", ")", ":", "if", "queue", ":", "_wait", "(", "kwargs", ".", "get", "(", "'__pub_jid'", ")", ")", "else", ":", "conflict", "=", "running", "(", "concurrent", "=", "kwargs", ".", "get", "(", "'concurrent...
Utility function to queue the state run if requested and to check for conflicts in currently running states
[ "Utility", "function", "to", "queue", "the", "state", "run", "if", "requested", "and", "to", "check", "for", "conflicts", "in", "currently", "running", "states" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L411-L422
train
saltstack/salt
salt/modules/state.py
low
def low(data, queue=False, **kwargs): ''' Execute a single low data call This function is mostly intended for testing the state system and is not likely to be needed in everyday usage. CLI Example: .. code-block:: bash salt '*' state.low '{"state": "pkg", "fun": "installed", "name": ...
python
def low(data, queue=False, **kwargs): ''' Execute a single low data call This function is mostly intended for testing the state system and is not likely to be needed in everyday usage. CLI Example: .. code-block:: bash salt '*' state.low '{"state": "pkg", "fun": "installed", "name": ...
[ "def", "low", "(", "data", ",", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "conflict", "=", "_check_queue", "(", "queue", ",", "kwargs", ")", "if", "conflict", "is", "not", "None", ":", "return", "conflict", "try", ":", "st_", "=", "...
Execute a single low data call This function is mostly intended for testing the state system and is not likely to be needed in everyday usage. CLI Example: .. code-block:: bash salt '*' state.low '{"state": "pkg", "fun": "installed", "name": "vi"}'
[ "Execute", "a", "single", "low", "data", "call" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L431-L460
train
saltstack/salt
salt/modules/state.py
high
def high(data, test=None, queue=False, **kwargs): ''' Execute the compound calls stored in a single set of high data This function is mostly intended for testing the state system and is not likely to be needed in everyday usage. CLI Example: .. code-block:: bash salt '*' state.high '...
python
def high(data, test=None, queue=False, **kwargs): ''' Execute the compound calls stored in a single set of high data This function is mostly intended for testing the state system and is not likely to be needed in everyday usage. CLI Example: .. code-block:: bash salt '*' state.high '...
[ "def", "high", "(", "data", ",", "test", "=", "None", ",", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "conflict", "=", "_check_queue", "(", "queue", ",", "kwargs", ")", "if", "conflict", "is", "not", "None", ":", "return", "conflict", ...
Execute the compound calls stored in a single set of high data This function is mostly intended for testing the state system and is not likely to be needed in everyday usage. CLI Example: .. code-block:: bash salt '*' state.high '{"vim": {"pkg": ["installed"]}}'
[ "Execute", "the", "compound", "calls", "stored", "in", "a", "single", "set", "of", "high", "data" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L480-L524
train
saltstack/salt
salt/modules/state.py
template
def template(tem, queue=False, **kwargs): ''' Execute the information stored in a template file on the minion. This function does not ask a master for a SLS file to render but instead directly processes the file at the provided path on the minion. CLI Example: .. code-block:: bash sa...
python
def template(tem, queue=False, **kwargs): ''' Execute the information stored in a template file on the minion. This function does not ask a master for a SLS file to render but instead directly processes the file at the provided path on the minion. CLI Example: .. code-block:: bash sa...
[ "def", "template", "(", "tem", ",", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "if", "'env'", "in", "kwargs", ":", "# \"env\" is not supported; Use \"saltenv\".", "kwargs", ".", "pop", "(", "'env'", ")", "conflict", "=", "_check_queue", "(", ...
Execute the information stored in a template file on the minion. This function does not ask a master for a SLS file to render but instead directly processes the file at the provided path on the minion. CLI Example: .. code-block:: bash salt '*' state.template '<Path to template on the minion...
[ "Execute", "the", "information", "stored", "in", "a", "template", "file", "on", "the", "minion", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L527-L576
train
saltstack/salt
salt/modules/state.py
template_str
def template_str(tem, queue=False, **kwargs): ''' Execute the information stored in a string from an sls template CLI Example: .. code-block:: bash salt '*' state.template_str '<Template String>' ''' conflict = _check_queue(queue, kwargs) if conflict is not None: return co...
python
def template_str(tem, queue=False, **kwargs): ''' Execute the information stored in a string from an sls template CLI Example: .. code-block:: bash salt '*' state.template_str '<Template String>' ''' conflict = _check_queue(queue, kwargs) if conflict is not None: return co...
[ "def", "template_str", "(", "tem", ",", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "conflict", "=", "_check_queue", "(", "queue", ",", "kwargs", ")", "if", "conflict", "is", "not", "None", ":", "return", "conflict", "opts", "=", "salt", ...
Execute the information stored in a string from an sls template CLI Example: .. code-block:: bash salt '*' state.template_str '<Template String>'
[ "Execute", "the", "information", "stored", "in", "a", "string", "from", "an", "sls", "template" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L579-L603
train
saltstack/salt
salt/modules/state.py
check_request
def check_request(name=None): ''' .. versionadded:: 2015.5.0 Return the state request information, if any CLI Example: .. code-block:: bash salt '*' state.check_request ''' notify_path = os.path.join(__opts__['cachedir'], 'req_state.p') serial = salt.payload.Serial(__opts__) ...
python
def check_request(name=None): ''' .. versionadded:: 2015.5.0 Return the state request information, if any CLI Example: .. code-block:: bash salt '*' state.check_request ''' notify_path = os.path.join(__opts__['cachedir'], 'req_state.p') serial = salt.payload.Serial(__opts__) ...
[ "def", "check_request", "(", "name", "=", "None", ")", ":", "notify_path", "=", "os", ".", "path", ".", "join", "(", "__opts__", "[", "'cachedir'", "]", ",", "'req_state.p'", ")", "serial", "=", "salt", ".", "payload", ".", "Serial", "(", "__opts__", "...
.. versionadded:: 2015.5.0 Return the state request information, if any CLI Example: .. code-block:: bash salt '*' state.check_request
[ "..", "versionadded", "::", "2015", ".", "5", ".", "0" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L825-L845
train
saltstack/salt
salt/modules/state.py
highstate
def highstate(test=None, queue=False, **kwargs): ''' Retrieve the state data from the salt master for this minion and execute it test Run states in test-only (dry-run) mode pillar Custom Pillar values, passed as a dictionary of key-value pairs .. code-block:: bash ...
python
def highstate(test=None, queue=False, **kwargs): ''' Retrieve the state data from the salt master for this minion and execute it test Run states in test-only (dry-run) mode pillar Custom Pillar values, passed as a dictionary of key-value pairs .. code-block:: bash ...
[ "def", "highstate", "(", "test", "=", "None", ",", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "if", "_disabled", "(", "[", "'highstate'", "]", ")", ":", "log", ".", "debug", "(", "'Salt highstate run is disabled. To re-enable, run state.enable h...
Retrieve the state data from the salt master for this minion and execute it test Run states in test-only (dry-run) mode pillar Custom Pillar values, passed as a dictionary of key-value pairs .. code-block:: bash salt '*' state.highstate stuff pillar='{"foo": "bar"}' ...
[ "Retrieve", "the", "state", "data", "from", "the", "salt", "master", "for", "this", "minion", "and", "execute", "it" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L921-L1098
train
saltstack/salt
salt/modules/state.py
sls
def sls(mods, test=None, exclude=None, queue=False, sync_mods=None, **kwargs): ''' Execute the states in one or more SLS files test Run states in test-only (dry-run) mode pillar Custom Pillar values, passed as a dictionary of key-value pairs .. code-block:: bash s...
python
def sls(mods, test=None, exclude=None, queue=False, sync_mods=None, **kwargs): ''' Execute the states in one or more SLS files test Run states in test-only (dry-run) mode pillar Custom Pillar values, passed as a dictionary of key-value pairs .. code-block:: bash s...
[ "def", "sls", "(", "mods", ",", "test", "=", "None", ",", "exclude", "=", "None", ",", "queue", "=", "False", ",", "sync_mods", "=", "None", ",", "*", "*", "kwargs", ")", ":", "concurrent", "=", "kwargs", ".", "get", "(", "'concurrent'", ",", "Fals...
Execute the states in one or more SLS files test Run states in test-only (dry-run) mode pillar Custom Pillar values, passed as a dictionary of key-value pairs .. code-block:: bash salt '*' state.sls stuff pillar='{"foo": "bar"}' .. note:: Values passe...
[ "Execute", "the", "states", "in", "one", "or", "more", "SLS", "files" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L1101-L1377
train
saltstack/salt
salt/modules/state.py
top
def top(topfn, test=None, queue=False, **kwargs): ''' Execute a specific top file instead of the default. This is useful to apply configurations from a different environment (for example, dev or prod), without modifying the default top file. queue : False Instead of failing immediately when...
python
def top(topfn, test=None, queue=False, **kwargs): ''' Execute a specific top file instead of the default. This is useful to apply configurations from a different environment (for example, dev or prod), without modifying the default top file. queue : False Instead of failing immediately when...
[ "def", "top", "(", "topfn", ",", "test", "=", "None", ",", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "conflict", "=", "_check_queue", "(", "queue", ",", "kwargs", ")", "if", "conflict", "is", "not", "None", ":", "return", "conflict", ...
Execute a specific top file instead of the default. This is useful to apply configurations from a different environment (for example, dev or prod), without modifying the default top file. queue : False Instead of failing immediately when another state run is in progress, queue the new state...
[ "Execute", "a", "specific", "top", "file", "instead", "of", "the", "default", ".", "This", "is", "useful", "to", "apply", "configurations", "from", "a", "different", "environment", "(", "for", "example", "dev", "or", "prod", ")", "without", "modifying", "the...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L1380-L1468
train
saltstack/salt
salt/modules/state.py
show_highstate
def show_highstate(queue=False, **kwargs): ''' Retrieve the highstate data from the salt master and display it Custom Pillar data can be passed with the ``pillar`` kwarg. CLI Example: .. code-block:: bash salt '*' state.show_highstate ''' conflict = _check_queue(queue, kwargs) ...
python
def show_highstate(queue=False, **kwargs): ''' Retrieve the highstate data from the salt master and display it Custom Pillar data can be passed with the ``pillar`` kwarg. CLI Example: .. code-block:: bash salt '*' state.show_highstate ''' conflict = _check_queue(queue, kwargs) ...
[ "def", "show_highstate", "(", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "conflict", "=", "_check_queue", "(", "queue", ",", "kwargs", ")", "if", "conflict", "is", "not", "None", ":", "return", "conflict", "pillar_override", "=", "kwargs", ...
Retrieve the highstate data from the salt master and display it Custom Pillar data can be passed with the ``pillar`` kwarg. CLI Example: .. code-block:: bash salt '*' state.show_highstate
[ "Retrieve", "the", "highstate", "data", "from", "the", "salt", "master", "and", "display", "it" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L1471-L1520
train
saltstack/salt
salt/modules/state.py
show_lowstate
def show_lowstate(queue=False, **kwargs): ''' List out the low data that will be applied to this minion CLI Example: .. code-block:: bash salt '*' state.show_lowstate ''' conflict = _check_queue(queue, kwargs) if conflict is not None: assert False return conflict ...
python
def show_lowstate(queue=False, **kwargs): ''' List out the low data that will be applied to this minion CLI Example: .. code-block:: bash salt '*' state.show_lowstate ''' conflict = _check_queue(queue, kwargs) if conflict is not None: assert False return conflict ...
[ "def", "show_lowstate", "(", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "conflict", "=", "_check_queue", "(", "queue", ",", "kwargs", ")", "if", "conflict", "is", "not", "None", ":", "assert", "False", "return", "conflict", "opts", "=", ...
List out the low data that will be applied to this minion CLI Example: .. code-block:: bash salt '*' state.show_lowstate
[ "List", "out", "the", "low", "data", "that", "will", "be", "applied", "to", "this", "minion" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L1523-L1557
train
saltstack/salt
salt/modules/state.py
show_state_usage
def show_state_usage(queue=False, **kwargs): ''' Retrieve the highstate data from the salt master to analyse used and unused states Custom Pillar data can be passed with the ``pillar`` kwarg. CLI Example: .. code-block:: bash salt '*' state.show_state_usage ''' conflict = _check_...
python
def show_state_usage(queue=False, **kwargs): ''' Retrieve the highstate data from the salt master to analyse used and unused states Custom Pillar data can be passed with the ``pillar`` kwarg. CLI Example: .. code-block:: bash salt '*' state.show_state_usage ''' conflict = _check_...
[ "def", "show_state_usage", "(", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "conflict", "=", "_check_queue", "(", "queue", ",", "kwargs", ")", "if", "conflict", "is", "not", "None", ":", "return", "conflict", "pillar", "=", "kwargs", ".", ...
Retrieve the highstate data from the salt master to analyse used and unused states Custom Pillar data can be passed with the ``pillar`` kwarg. CLI Example: .. code-block:: bash salt '*' state.show_state_usage
[ "Retrieve", "the", "highstate", "data", "from", "the", "salt", "master", "to", "analyse", "used", "and", "unused", "states" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L1560-L1593
train
saltstack/salt
salt/modules/state.py
show_states
def show_states(queue=False, **kwargs): ''' Returns the list of states that will be applied on highstate. CLI Example: .. code-block:: bash salt '*' state.show_states .. versionadded:: 2019.2.0 ''' conflict = _check_queue(queue, kwargs) if conflict is not None: asser...
python
def show_states(queue=False, **kwargs): ''' Returns the list of states that will be applied on highstate. CLI Example: .. code-block:: bash salt '*' state.show_states .. versionadded:: 2019.2.0 ''' conflict = _check_queue(queue, kwargs) if conflict is not None: asser...
[ "def", "show_states", "(", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "conflict", "=", "_check_queue", "(", "queue", ",", "kwargs", ")", "if", "conflict", "is", "not", "None", ":", "assert", "False", "return", "conflict", "opts", "=", "s...
Returns the list of states that will be applied on highstate. CLI Example: .. code-block:: bash salt '*' state.show_states .. versionadded:: 2019.2.0
[ "Returns", "the", "list", "of", "states", "that", "will", "be", "applied", "on", "highstate", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L1596-L1641
train
saltstack/salt
salt/modules/state.py
sls_id
def sls_id(id_, mods, test=None, queue=False, **kwargs): ''' Call a single ID from the named module(s) and handle all requisites The state ID comes *before* the module ID(s) on the command line. id ID to call mods Comma-delimited list of modules to search for given id and its requ...
python
def sls_id(id_, mods, test=None, queue=False, **kwargs): ''' Call a single ID from the named module(s) and handle all requisites The state ID comes *before* the module ID(s) on the command line. id ID to call mods Comma-delimited list of modules to search for given id and its requ...
[ "def", "sls_id", "(", "id_", ",", "mods", ",", "test", "=", "None", ",", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "conflict", "=", "_check_queue", "(", "queue", ",", "kwargs", ")", "if", "conflict", "is", "not", "None", ":", "retur...
Call a single ID from the named module(s) and handle all requisites The state ID comes *before* the module ID(s) on the command line. id ID to call mods Comma-delimited list of modules to search for given id and its requisites .. versionadded:: 2014.7.0 saltenv : base Sp...
[ "Call", "a", "single", "ID", "from", "the", "named", "module", "(", "s", ")", "and", "handle", "all", "requisites" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L1644-L1760
train
saltstack/salt
salt/modules/state.py
show_low_sls
def show_low_sls(mods, test=None, queue=False, **kwargs): ''' Display the low data from a specific sls. The default environment is ``base``, use ``saltenv`` to specify a different environment. saltenv Specify a salt fileserver environment to be used when applying states pillar Cust...
python
def show_low_sls(mods, test=None, queue=False, **kwargs): ''' Display the low data from a specific sls. The default environment is ``base``, use ``saltenv`` to specify a different environment. saltenv Specify a salt fileserver environment to be used when applying states pillar Cust...
[ "def", "show_low_sls", "(", "mods", ",", "test", "=", "None", ",", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "if", "'env'", "in", "kwargs", ":", "# \"env\" is not supported; Use \"saltenv\".", "kwargs", ".", "pop", "(", "'env'", ")", "confl...
Display the low data from a specific sls. The default environment is ``base``, use ``saltenv`` to specify a different environment. saltenv Specify a salt fileserver environment to be used when applying states pillar Custom Pillar values, passed as a dictionary of key-value pairs ....
[ "Display", "the", "low", "data", "from", "a", "specific", "sls", ".", "The", "default", "environment", "is", "base", "use", "saltenv", "to", "specify", "a", "different", "environment", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L1763-L1851
train
saltstack/salt
salt/modules/state.py
sls_exists
def sls_exists(mods, test=None, queue=False, **kwargs): ''' Tests for the existance the of a specific SLS or list of SLS files on the master. Similar to :py:func:`state.show_sls <salt.modules.state.show_sls>`, rather than returning state details, returns True or False. The default environment is ``b...
python
def sls_exists(mods, test=None, queue=False, **kwargs): ''' Tests for the existance the of a specific SLS or list of SLS files on the master. Similar to :py:func:`state.show_sls <salt.modules.state.show_sls>`, rather than returning state details, returns True or False. The default environment is ``b...
[ "def", "sls_exists", "(", "mods", ",", "test", "=", "None", ",", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "return", "isinstance", "(", "show_sls", "(", "mods", ",", "test", "=", "test", ",", "queue", "=", "queue", ",", "*", "*", ...
Tests for the existance the of a specific SLS or list of SLS files on the master. Similar to :py:func:`state.show_sls <salt.modules.state.show_sls>`, rather than returning state details, returns True or False. The default environment is ``base``, use ``saltenv`` to specify a different environment. .. v...
[ "Tests", "for", "the", "existance", "the", "of", "a", "specific", "SLS", "or", "list", "of", "SLS", "files", "on", "the", "master", ".", "Similar", "to", ":", "py", ":", "func", ":", "state", ".", "show_sls", "<salt", ".", "modules", ".", "state", "....
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L1941-L1963
train
saltstack/salt
salt/modules/state.py
id_exists
def id_exists(ids, mods, test=None, queue=False, **kwargs): ''' Tests for the existence of a specific ID or list of IDs within the specified SLS file(s). Similar to :py:func:`state.sls_exists <salt.modules.state.sls_exists>`, returns True or False. The default environment is base``, use ``saltenv`` ...
python
def id_exists(ids, mods, test=None, queue=False, **kwargs): ''' Tests for the existence of a specific ID or list of IDs within the specified SLS file(s). Similar to :py:func:`state.sls_exists <salt.modules.state.sls_exists>`, returns True or False. The default environment is base``, use ``saltenv`` ...
[ "def", "id_exists", "(", "ids", ",", "mods", ",", "test", "=", "None", ",", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "ids", "=", "salt", ".", "utils", ".", "args", ".", "split_input", "(", "ids", ")", "ids", "=", "set", "(", "i...
Tests for the existence of a specific ID or list of IDs within the specified SLS file(s). Similar to :py:func:`state.sls_exists <salt.modules.state.sls_exists>`, returns True or False. The default environment is base``, use ``saltenv`` to specify a different environment. .. versionadded:: 2019.2.0 ...
[ "Tests", "for", "the", "existence", "of", "a", "specific", "ID", "or", "list", "of", "IDs", "within", "the", "specified", "SLS", "file", "(", "s", ")", ".", "Similar", "to", ":", "py", ":", "func", ":", "state", ".", "sls_exists", "<salt", ".", "modu...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L1966-L1988
train
saltstack/salt
salt/modules/state.py
show_top
def show_top(queue=False, **kwargs): ''' Return the top data that the minion will use for a highstate CLI Example: .. code-block:: bash salt '*' state.show_top ''' if 'env' in kwargs: # "env" is not supported; Use "saltenv". kwargs.pop('env') conflict = _check_que...
python
def show_top(queue=False, **kwargs): ''' Return the top data that the minion will use for a highstate CLI Example: .. code-block:: bash salt '*' state.show_top ''' if 'env' in kwargs: # "env" is not supported; Use "saltenv". kwargs.pop('env') conflict = _check_que...
[ "def", "show_top", "(", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "if", "'env'", "in", "kwargs", ":", "# \"env\" is not supported; Use \"saltenv\".", "kwargs", ".", "pop", "(", "'env'", ")", "conflict", "=", "_check_queue", "(", "queue", ",",...
Return the top data that the minion will use for a highstate CLI Example: .. code-block:: bash salt '*' state.show_top
[ "Return", "the", "top", "data", "that", "the", "minion", "will", "use", "for", "a", "highstate" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L1991-L2029
train
saltstack/salt
salt/modules/state.py
single
def single(fun, name, test=None, queue=False, **kwargs): ''' Execute a single state function with the named kwargs, returns False if insufficient data is sent to the command By default, the values of the kwargs will be parsed as YAML. So, you can specify lists values, or lists of single entry key-v...
python
def single(fun, name, test=None, queue=False, **kwargs): ''' Execute a single state function with the named kwargs, returns False if insufficient data is sent to the command By default, the values of the kwargs will be parsed as YAML. So, you can specify lists values, or lists of single entry key-v...
[ "def", "single", "(", "fun", ",", "name", ",", "test", "=", "None", ",", "queue", "=", "False", ",", "*", "*", "kwargs", ")", ":", "conflict", "=", "_check_queue", "(", "queue", ",", "kwargs", ")", "if", "conflict", "is", "not", "None", ":", "retur...
Execute a single state function with the named kwargs, returns False if insufficient data is sent to the command By default, the values of the kwargs will be parsed as YAML. So, you can specify lists values, or lists of single entry key-value maps, as you would in a YAML salt file. Alternatively, JSON ...
[ "Execute", "a", "single", "state", "function", "with", "the", "named", "kwargs", "returns", "False", "if", "insufficient", "data", "is", "sent", "to", "the", "command" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L2032-L2099
train
saltstack/salt
salt/modules/state.py
clear_cache
def clear_cache(): ''' Clear out cached state files, forcing even cache runs to refresh the cache on the next state execution. Remember that the state cache is completely disabled by default, this execution only applies if cache=True is used in states CLI Example: .. code-block:: bash ...
python
def clear_cache(): ''' Clear out cached state files, forcing even cache runs to refresh the cache on the next state execution. Remember that the state cache is completely disabled by default, this execution only applies if cache=True is used in states CLI Example: .. code-block:: bash ...
[ "def", "clear_cache", "(", ")", ":", "ret", "=", "[", "]", "for", "fn_", "in", "os", ".", "listdir", "(", "__opts__", "[", "'cachedir'", "]", ")", ":", "if", "fn_", ".", "endswith", "(", "'.cache.p'", ")", ":", "path", "=", "os", ".", "path", "."...
Clear out cached state files, forcing even cache runs to refresh the cache on the next state execution. Remember that the state cache is completely disabled by default, this execution only applies if cache=True is used in states CLI Example: .. code-block:: bash salt '*' state.clear_cach...
[ "Clear", "out", "cached", "state", "files", "forcing", "even", "cache", "runs", "to", "refresh", "the", "cache", "on", "the", "next", "state", "execution", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L2102-L2124
train
saltstack/salt
salt/modules/state.py
pkg
def pkg(pkg_path, pkg_sum, hash_type, test=None, **kwargs): ''' Execute a packaged state run, the packaged state run will exist in a tarball available locally. This packaged state can be generated using salt-ssh. CLI Example: .. code-block:: bash salt '...
python
def pkg(pkg_path, pkg_sum, hash_type, test=None, **kwargs): ''' Execute a packaged state run, the packaged state run will exist in a tarball available locally. This packaged state can be generated using salt-ssh. CLI Example: .. code-block:: bash salt '...
[ "def", "pkg", "(", "pkg_path", ",", "pkg_sum", ",", "hash_type", ",", "test", "=", "None", ",", "*", "*", "kwargs", ")", ":", "# TODO - Add ability to download from salt master or other source", "popts", "=", "salt", ".", "utils", ".", "state", ".", "get_sls_opt...
Execute a packaged state run, the packaged state run will exist in a tarball available locally. This packaged state can be generated using salt-ssh. CLI Example: .. code-block:: bash salt '*' state.pkg /tmp/salt_state.tgz 760a9353810e36f6d81416366fc426dc md5
[ "Execute", "a", "packaged", "state", "run", "the", "packaged", "state", "run", "will", "exist", "in", "a", "tarball", "available", "locally", ".", "This", "packaged", "state", "can", "be", "generated", "using", "salt", "-", "ssh", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L2127-L2200
train
saltstack/salt
salt/modules/state.py
disable
def disable(states): ''' Disable state runs. CLI Example: .. code-block:: bash salt '*' state.disable highstate salt '*' state.disable highstate,test.succeed_without_changes .. note:: To disable a state file from running provide the same name that would be passed...
python
def disable(states): ''' Disable state runs. CLI Example: .. code-block:: bash salt '*' state.disable highstate salt '*' state.disable highstate,test.succeed_without_changes .. note:: To disable a state file from running provide the same name that would be passed...
[ "def", "disable", "(", "states", ")", ":", "ret", "=", "{", "'res'", ":", "True", ",", "'msg'", ":", "''", "}", "states", "=", "salt", ".", "utils", ".", "args", ".", "split_input", "(", "states", ")", "msg", "=", "[", "]", "_disabled", "=", "__s...
Disable state runs. CLI Example: .. code-block:: bash salt '*' state.disable highstate salt '*' state.disable highstate,test.succeed_without_changes .. note:: To disable a state file from running provide the same name that would be passed in a state.sls call. sa...
[ "Disable", "state", "runs", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L2203-L2251
train
saltstack/salt
salt/modules/state.py
enable
def enable(states): ''' Enable state function or sls run CLI Example: .. code-block:: bash salt '*' state.enable highstate salt '*' state.enable test.succeed_without_changes .. note:: To enable a state file from running provide the same name that would be passed ...
python
def enable(states): ''' Enable state function or sls run CLI Example: .. code-block:: bash salt '*' state.enable highstate salt '*' state.enable test.succeed_without_changes .. note:: To enable a state file from running provide the same name that would be passed ...
[ "def", "enable", "(", "states", ")", ":", "ret", "=", "{", "'res'", ":", "True", ",", "'msg'", ":", "''", "}", "states", "=", "salt", ".", "utils", ".", "args", ".", "split_input", "(", "states", ")", "log", ".", "debug", "(", "'states %s'", ",", ...
Enable state function or sls run CLI Example: .. code-block:: bash salt '*' state.enable highstate salt '*' state.enable test.succeed_without_changes .. note:: To enable a state file from running provide the same name that would be passed in a state.sls call. sa...
[ "Enable", "state", "function", "or", "sls", "run" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L2254-L2304
train
saltstack/salt
salt/modules/state.py
_disabled
def _disabled(funs): ''' Return messages for disabled states that match state functions in funs. ''' ret = [] _disabled = __salt__['grains.get']('state_runs_disabled') for state in funs: for _state in _disabled: if '.*' in _state: target_state = _state.spl...
python
def _disabled(funs): ''' Return messages for disabled states that match state functions in funs. ''' ret = [] _disabled = __salt__['grains.get']('state_runs_disabled') for state in funs: for _state in _disabled: if '.*' in _state: target_state = _state.spl...
[ "def", "_disabled", "(", "funs", ")", ":", "ret", "=", "[", "]", "_disabled", "=", "__salt__", "[", "'grains.get'", "]", "(", "'state_runs_disabled'", ")", "for", "state", "in", "funs", ":", "for", "_state", "in", "_disabled", ":", "if", "'.*'", "in", ...
Return messages for disabled states that match state functions in funs.
[ "Return", "messages", "for", "disabled", "states", "that", "match", "state", "functions", "in", "funs", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L2320-L2352
train
saltstack/salt
salt/modules/state.py
event
def event(tagmatch='*', count=-1, quiet=False, sock_dir=None, pretty=False, node='minion'): r''' Watch Salt's event bus and block until the given tag is matched .. versionadded:: 2016.3.0 .. versionchanged:: 2019.2.0 ``tagmatch`` can now be eith...
python
def event(tagmatch='*', count=-1, quiet=False, sock_dir=None, pretty=False, node='minion'): r''' Watch Salt's event bus and block until the given tag is matched .. versionadded:: 2016.3.0 .. versionchanged:: 2019.2.0 ``tagmatch`` can now be eith...
[ "def", "event", "(", "tagmatch", "=", "'*'", ",", "count", "=", "-", "1", ",", "quiet", "=", "False", ",", "sock_dir", "=", "None", ",", "pretty", "=", "False", ",", "node", "=", "'minion'", ")", ":", "sevent", "=", "salt", ".", "utils", ".", "ev...
r''' Watch Salt's event bus and block until the given tag is matched .. versionadded:: 2016.3.0 .. versionchanged:: 2019.2.0 ``tagmatch`` can now be either a glob or regular expression. This is useful for utilizing Salt's event bus from shell scripts or for taking simple actions directly f...
[ "r", "Watch", "Salt", "s", "event", "bus", "and", "block", "until", "the", "given", "tag", "is", "matched" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/state.py#L2355-L2422
train
saltstack/salt
salt/states/grains.py
exists
def exists(name, delimiter=DEFAULT_TARGET_DELIM): ''' Ensure that a grain is set name The grain name delimiter A delimiter different from the default can be provided. Check whether a grain exists. Does not attempt to check or set the value. ''' name = re.sub(delimiter, DEF...
python
def exists(name, delimiter=DEFAULT_TARGET_DELIM): ''' Ensure that a grain is set name The grain name delimiter A delimiter different from the default can be provided. Check whether a grain exists. Does not attempt to check or set the value. ''' name = re.sub(delimiter, DEF...
[ "def", "exists", "(", "name", ",", "delimiter", "=", "DEFAULT_TARGET_DELIM", ")", ":", "name", "=", "re", ".", "sub", "(", "delimiter", ",", "DEFAULT_TARGET_DELIM", ",", "name", ")", "ret", "=", "{", "'name'", ":", "name", ",", "'changes'", ":", "{", "...
Ensure that a grain is set name The grain name delimiter A delimiter different from the default can be provided. Check whether a grain exists. Does not attempt to check or set the value.
[ "Ensure", "that", "a", "grain", "is", "set" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/grains.py#L23-L45
train
saltstack/salt
salt/states/grains.py
present
def present(name, value, delimiter=DEFAULT_TARGET_DELIM, force=False): ''' Ensure that a grain is set .. versionchanged:: v2015.8.2 name The grain name value The value to set on the grain force If force is True, the existing grain will be overwritten regardles...
python
def present(name, value, delimiter=DEFAULT_TARGET_DELIM, force=False): ''' Ensure that a grain is set .. versionchanged:: v2015.8.2 name The grain name value The value to set on the grain force If force is True, the existing grain will be overwritten regardles...
[ "def", "present", "(", "name", ",", "value", ",", "delimiter", "=", "DEFAULT_TARGET_DELIM", ",", "force", "=", "False", ")", ":", "name", "=", "re", ".", "sub", "(", "delimiter", ",", "DEFAULT_TARGET_DELIM", ",", "name", ")", "ret", "=", "{", "'name'", ...
Ensure that a grain is set .. versionchanged:: v2015.8.2 name The grain name value The value to set on the grain force If force is True, the existing grain will be overwritten regardless of its existing or provided value type. Defaults to False .. versionadde...
[ "Ensure", "that", "a", "grain", "is", "set" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/grains.py#L48-L124
train
saltstack/salt
salt/states/grains.py
list_present
def list_present(name, value, delimiter=DEFAULT_TARGET_DELIM): ''' .. versionadded:: 2014.1.0 Ensure the value is present in the list-type grain. Note: If the grain that is provided in ``name`` is not present on the system, this new grain will be created with the corresponding provided value. ...
python
def list_present(name, value, delimiter=DEFAULT_TARGET_DELIM): ''' .. versionadded:: 2014.1.0 Ensure the value is present in the list-type grain. Note: If the grain that is provided in ``name`` is not present on the system, this new grain will be created with the corresponding provided value. ...
[ "def", "list_present", "(", "name", ",", "value", ",", "delimiter", "=", "DEFAULT_TARGET_DELIM", ")", ":", "name", "=", "re", ".", "sub", "(", "delimiter", ",", "DEFAULT_TARGET_DELIM", ",", "name", ")", "ret", "=", "{", "'name'", ":", "name", ",", "'chan...
.. versionadded:: 2014.1.0 Ensure the value is present in the list-type grain. Note: If the grain that is provided in ``name`` is not present on the system, this new grain will be created with the corresponding provided value. name The grain name. value The value is present in the...
[ "..", "versionadded", "::", "2014", ".", "1", ".", "0" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/grains.py#L127-L219
train
saltstack/salt
salt/states/grains.py
list_absent
def list_absent(name, value, delimiter=DEFAULT_TARGET_DELIM): ''' Delete a value from a grain formed as a list. .. versionadded:: 2014.1.0 name The grain name. value The value to delete from the grain list. delimiter A delimiter different from the default ``:`` can be ...
python
def list_absent(name, value, delimiter=DEFAULT_TARGET_DELIM): ''' Delete a value from a grain formed as a list. .. versionadded:: 2014.1.0 name The grain name. value The value to delete from the grain list. delimiter A delimiter different from the default ``:`` can be ...
[ "def", "list_absent", "(", "name", ",", "value", ",", "delimiter", "=", "DEFAULT_TARGET_DELIM", ")", ":", "name", "=", "re", ".", "sub", "(", "delimiter", ",", "DEFAULT_TARGET_DELIM", ",", "name", ")", "ret", "=", "{", "'name'", ":", "name", ",", "'chang...
Delete a value from a grain formed as a list. .. versionadded:: 2014.1.0 name The grain name. value The value to delete from the grain list. delimiter A delimiter different from the default ``:`` can be provided. .. versionadded:: v2015.8.2 The grain should be `l...
[ "Delete", "a", "value", "from", "a", "grain", "formed", "as", "a", "list", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/grains.py#L222-L295
train
saltstack/salt
salt/states/grains.py
absent
def absent(name, destructive=False, delimiter=DEFAULT_TARGET_DELIM, force=False): ''' .. versionadded:: 2014.7.0 Delete a grain from the grains config file name The grain name destructive If destructive is True, delete the entire grain. If ...
python
def absent(name, destructive=False, delimiter=DEFAULT_TARGET_DELIM, force=False): ''' .. versionadded:: 2014.7.0 Delete a grain from the grains config file name The grain name destructive If destructive is True, delete the entire grain. If ...
[ "def", "absent", "(", "name", ",", "destructive", "=", "False", ",", "delimiter", "=", "DEFAULT_TARGET_DELIM", ",", "force", "=", "False", ")", ":", "_non_existent", "=", "object", "(", ")", "name", "=", "re", ".", "sub", "(", "delimiter", ",", "DEFAULT_...
.. versionadded:: 2014.7.0 Delete a grain from the grains config file name The grain name destructive If destructive is True, delete the entire grain. If destructive is False, set the grain's value to None. Defaults to False. force If force is True, the existing grain...
[ "..", "versionadded", "::", "2014", ".", "7", ".", "0" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/grains.py#L298-L386
train
saltstack/salt
salt/states/grains.py
append
def append(name, value, convert=False, delimiter=DEFAULT_TARGET_DELIM): ''' .. versionadded:: 2014.7.0 Append a value to a list in the grains config file. The grain that is being appended to (name) must exist before the new value can be added. name The grain name value ...
python
def append(name, value, convert=False, delimiter=DEFAULT_TARGET_DELIM): ''' .. versionadded:: 2014.7.0 Append a value to a list in the grains config file. The grain that is being appended to (name) must exist before the new value can be added. name The grain name value ...
[ "def", "append", "(", "name", ",", "value", ",", "convert", "=", "False", ",", "delimiter", "=", "DEFAULT_TARGET_DELIM", ")", ":", "name", "=", "re", ".", "sub", "(", "delimiter", ",", "DEFAULT_TARGET_DELIM", ",", "name", ")", "ret", "=", "{", "'name'", ...
.. versionadded:: 2014.7.0 Append a value to a list in the grains config file. The grain that is being appended to (name) must exist before the new value can be added. name The grain name value The value to append convert If convert is True, convert non-list contents into...
[ "..", "versionadded", "::", "2014", ".", "7", ".", "0" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/grains.py#L389-L464
train
saltstack/salt
salt/modules/chocolatey.py
_clear_context
def _clear_context(context): ''' Clear variables stored in __context__. Run this function when a new version of chocolatey is installed. ''' for var in (x for x in __context__ if x.startswith('chocolatey.')): context.pop(var)
python
def _clear_context(context): ''' Clear variables stored in __context__. Run this function when a new version of chocolatey is installed. ''' for var in (x for x in __context__ if x.startswith('chocolatey.')): context.pop(var)
[ "def", "_clear_context", "(", "context", ")", ":", "for", "var", "in", "(", "x", "for", "x", "in", "__context__", "if", "x", ".", "startswith", "(", "'chocolatey.'", ")", ")", ":", "context", ".", "pop", "(", "var", ")" ]
Clear variables stored in __context__. Run this function when a new version of chocolatey is installed.
[ "Clear", "variables", "stored", "in", "__context__", ".", "Run", "this", "function", "when", "a", "new", "version", "of", "chocolatey", "is", "installed", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L51-L57
train
saltstack/salt
salt/modules/chocolatey.py
_yes
def _yes(context): ''' Returns ['--yes'] if on v0.9.9.0 or later, otherwise returns an empty list ''' if 'chocolatey._yes' in __context__: return context['chocolatey._yes'] if _LooseVersion(chocolatey_version()) >= _LooseVersion('0.9.9'): answer = ['--yes'] else: answer =...
python
def _yes(context): ''' Returns ['--yes'] if on v0.9.9.0 or later, otherwise returns an empty list ''' if 'chocolatey._yes' in __context__: return context['chocolatey._yes'] if _LooseVersion(chocolatey_version()) >= _LooseVersion('0.9.9'): answer = ['--yes'] else: answer =...
[ "def", "_yes", "(", "context", ")", ":", "if", "'chocolatey._yes'", "in", "__context__", ":", "return", "context", "[", "'chocolatey._yes'", "]", "if", "_LooseVersion", "(", "chocolatey_version", "(", ")", ")", ">=", "_LooseVersion", "(", "'0.9.9'", ")", ":", ...
Returns ['--yes'] if on v0.9.9.0 or later, otherwise returns an empty list
[ "Returns", "[", "--", "yes", "]", "if", "on", "v0", ".", "9", ".", "9", ".", "0", "or", "later", "otherwise", "returns", "an", "empty", "list" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L60-L71
train
saltstack/salt
salt/modules/chocolatey.py
_no_progress
def _no_progress(context): ''' Returns ['--no-progress'] if on v0.10.4 or later, otherwise returns an empty list ''' if 'chocolatey._no_progress' in __context__: return context['chocolatey._no_progress'] if _LooseVersion(chocolatey_version()) >= _LooseVersion('0.10.4'): answer = ...
python
def _no_progress(context): ''' Returns ['--no-progress'] if on v0.10.4 or later, otherwise returns an empty list ''' if 'chocolatey._no_progress' in __context__: return context['chocolatey._no_progress'] if _LooseVersion(chocolatey_version()) >= _LooseVersion('0.10.4'): answer = ...
[ "def", "_no_progress", "(", "context", ")", ":", "if", "'chocolatey._no_progress'", "in", "__context__", ":", "return", "context", "[", "'chocolatey._no_progress'", "]", "if", "_LooseVersion", "(", "chocolatey_version", "(", ")", ")", ">=", "_LooseVersion", "(", "...
Returns ['--no-progress'] if on v0.10.4 or later, otherwise returns an empty list
[ "Returns", "[", "--", "no", "-", "progress", "]", "if", "on", "v0", ".", "10", ".", "4", "or", "later", "otherwise", "returns", "an", "empty", "list" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L74-L87
train
saltstack/salt
salt/modules/chocolatey.py
_find_chocolatey
def _find_chocolatey(context, salt): ''' Returns the full path to chocolatey.bat on the host. ''' if 'chocolatey._path' in context: return context['chocolatey._path'] choc_defaults = ['C:\\Chocolatey\\bin\\chocolatey.bat', 'C:\\ProgramData\\Chocolatey\\bin\\chocolatey.ex...
python
def _find_chocolatey(context, salt): ''' Returns the full path to chocolatey.bat on the host. ''' if 'chocolatey._path' in context: return context['chocolatey._path'] choc_defaults = ['C:\\Chocolatey\\bin\\chocolatey.bat', 'C:\\ProgramData\\Chocolatey\\bin\\chocolatey.ex...
[ "def", "_find_chocolatey", "(", "context", ",", "salt", ")", ":", "if", "'chocolatey._path'", "in", "context", ":", "return", "context", "[", "'chocolatey._path'", "]", "choc_defaults", "=", "[", "'C:\\\\Chocolatey\\\\bin\\\\chocolatey.bat'", ",", "'C:\\\\ProgramData\\\...
Returns the full path to chocolatey.bat on the host.
[ "Returns", "the", "full", "path", "to", "chocolatey", ".", "bat", "on", "the", "host", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L90-L109
train
saltstack/salt
salt/modules/chocolatey.py
chocolatey_version
def chocolatey_version(): ''' Returns the version of Chocolatey installed on the minion. CLI Example: .. code-block:: bash salt '*' chocolatey.chocolatey_version ''' if 'chocolatey._version' in __context__: return __context__['chocolatey._version'] cmd = [_find_chocolatey...
python
def chocolatey_version(): ''' Returns the version of Chocolatey installed on the minion. CLI Example: .. code-block:: bash salt '*' chocolatey.chocolatey_version ''' if 'chocolatey._version' in __context__: return __context__['chocolatey._version'] cmd = [_find_chocolatey...
[ "def", "chocolatey_version", "(", ")", ":", "if", "'chocolatey._version'", "in", "__context__", ":", "return", "__context__", "[", "'chocolatey._version'", "]", "cmd", "=", "[", "_find_chocolatey", "(", "__context__", ",", "__salt__", ")", "]", "cmd", ".", "appe...
Returns the version of Chocolatey installed on the minion. CLI Example: .. code-block:: bash salt '*' chocolatey.chocolatey_version
[ "Returns", "the", "version", "of", "Chocolatey", "installed", "on", "the", "minion", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L112-L130
train
saltstack/salt
salt/modules/chocolatey.py
bootstrap
def bootstrap(force=False): ''' Download and install the latest version of the Chocolatey package manager via the official bootstrap. Chocolatey requires Windows PowerShell and the .NET v4.0 runtime. Depending on the host's version of Windows, chocolatey.bootstrap will attempt to ensure these p...
python
def bootstrap(force=False): ''' Download and install the latest version of the Chocolatey package manager via the official bootstrap. Chocolatey requires Windows PowerShell and the .NET v4.0 runtime. Depending on the host's version of Windows, chocolatey.bootstrap will attempt to ensure these p...
[ "def", "bootstrap", "(", "force", "=", "False", ")", ":", "# Check if Chocolatey is already present in the path", "try", ":", "choc_path", "=", "_find_chocolatey", "(", "__context__", ",", "__salt__", ")", "except", "CommandExecutionError", ":", "choc_path", "=", "Non...
Download and install the latest version of the Chocolatey package manager via the official bootstrap. Chocolatey requires Windows PowerShell and the .NET v4.0 runtime. Depending on the host's version of Windows, chocolatey.bootstrap will attempt to ensure these prerequisites are met by downloading and ...
[ "Download", "and", "install", "the", "latest", "version", "of", "the", "Chocolatey", "package", "manager", "via", "the", "official", "bootstrap", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L133-L226
train
saltstack/salt
salt/modules/chocolatey.py
list_
def list_(narrow=None, all_versions=False, pre_versions=False, source=None, local_only=False, exact=False): ''' Instructs Chocolatey to pull a vague package list from the repository. Args: narrow (str): Term used to narrow down results....
python
def list_(narrow=None, all_versions=False, pre_versions=False, source=None, local_only=False, exact=False): ''' Instructs Chocolatey to pull a vague package list from the repository. Args: narrow (str): Term used to narrow down results....
[ "def", "list_", "(", "narrow", "=", "None", ",", "all_versions", "=", "False", ",", "pre_versions", "=", "False", ",", "source", "=", "None", ",", "local_only", "=", "False", ",", "exact", "=", "False", ")", ":", "choc_path", "=", "_find_chocolatey", "("...
Instructs Chocolatey to pull a vague package list from the repository. Args: narrow (str): Term used to narrow down results. Searches against name/description/tag. Default is None. all_versions (bool): Display all available package versions in results. Default ...
[ "Instructs", "Chocolatey", "to", "pull", "a", "vague", "package", "list", "from", "the", "repository", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L229-L311
train
saltstack/salt
salt/modules/chocolatey.py
list_windowsfeatures
def list_windowsfeatures(): ''' Instructs Chocolatey to pull a full package list from the Windows Features list, via the Deployment Image Servicing and Management tool. Returns: str: List of Windows Features CLI Example: .. code-block:: bash salt '*' chocolatey.list_windowsfe...
python
def list_windowsfeatures(): ''' Instructs Chocolatey to pull a full package list from the Windows Features list, via the Deployment Image Servicing and Management tool. Returns: str: List of Windows Features CLI Example: .. code-block:: bash salt '*' chocolatey.list_windowsfe...
[ "def", "list_windowsfeatures", "(", ")", ":", "choc_path", "=", "_find_chocolatey", "(", "__context__", ",", "__salt__", ")", "cmd", "=", "[", "choc_path", ",", "'list'", ",", "'--source'", ",", "'windowsfeatures'", "]", "result", "=", "__salt__", "[", "'cmd.r...
Instructs Chocolatey to pull a full package list from the Windows Features list, via the Deployment Image Servicing and Management tool. Returns: str: List of Windows Features CLI Example: .. code-block:: bash salt '*' chocolatey.list_windowsfeatures
[ "Instructs", "Chocolatey", "to", "pull", "a", "full", "package", "list", "from", "the", "Windows", "Features", "list", "via", "the", "Deployment", "Image", "Servicing", "and", "Management", "tool", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L340-L363
train
saltstack/salt
salt/modules/chocolatey.py
install_cygwin
def install_cygwin(name, install_args=None, override_args=False): ''' Instructs Chocolatey to install a package via Cygwin. name The name of the package to be installed. Only accepts a single argument. install_args A list of install arguments you want to pass to the installation proces...
python
def install_cygwin(name, install_args=None, override_args=False): ''' Instructs Chocolatey to install a package via Cygwin. name The name of the package to be installed. Only accepts a single argument. install_args A list of install arguments you want to pass to the installation proces...
[ "def", "install_cygwin", "(", "name", ",", "install_args", "=", "None", ",", "override_args", "=", "False", ")", ":", "return", "install", "(", "name", ",", "source", "=", "'cygwin'", ",", "install_args", "=", "install_args", ",", "override_args", "=", "over...
Instructs Chocolatey to install a package via Cygwin. name The name of the package to be installed. Only accepts a single argument. install_args A list of install arguments you want to pass to the installation process i.e product key or feature list override_args Set to tr...
[ "Instructs", "Chocolatey", "to", "install", "a", "package", "via", "Cygwin", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L496-L523
train
saltstack/salt
salt/modules/chocolatey.py
install_gem
def install_gem(name, version=None, install_args=None, override_args=False): ''' Instructs Chocolatey to install a package via Ruby's Gems. name The name of the package to be installed. Only accepts a single argument. version Install a specific version of the package. Defaults to lates...
python
def install_gem(name, version=None, install_args=None, override_args=False): ''' Instructs Chocolatey to install a package via Ruby's Gems. name The name of the package to be installed. Only accepts a single argument. version Install a specific version of the package. Defaults to lates...
[ "def", "install_gem", "(", "name", ",", "version", "=", "None", ",", "install_args", "=", "None", ",", "override_args", "=", "False", ")", ":", "return", "install", "(", "name", ",", "version", "=", "version", ",", "source", "=", "'ruby'", ",", "install_...
Instructs Chocolatey to install a package via Ruby's Gems. name The name of the package to be installed. Only accepts a single argument. version Install a specific version of the package. Defaults to latest version available. install_args A list of install arguments you wa...
[ "Instructs", "Chocolatey", "to", "install", "a", "package", "via", "Ruby", "s", "Gems", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L526-L560
train
saltstack/salt
salt/modules/chocolatey.py
install_missing
def install_missing(name, version=None, source=None): ''' Instructs Chocolatey to install a package if it doesn't already exist. .. versionchanged:: 2014.7.0 If the minion has Chocolatey >= 0.9.8.24 installed, this function calls :mod:`chocolatey.install <salt.modules.chocolatey.install>` i...
python
def install_missing(name, version=None, source=None): ''' Instructs Chocolatey to install a package if it doesn't already exist. .. versionchanged:: 2014.7.0 If the minion has Chocolatey >= 0.9.8.24 installed, this function calls :mod:`chocolatey.install <salt.modules.chocolatey.install>` i...
[ "def", "install_missing", "(", "name", ",", "version", "=", "None", ",", "source", "=", "None", ")", ":", "choc_path", "=", "_find_chocolatey", "(", "__context__", ",", "__salt__", ")", "if", "_LooseVersion", "(", "chocolatey_version", "(", ")", ")", ">=", ...
Instructs Chocolatey to install a package if it doesn't already exist. .. versionchanged:: 2014.7.0 If the minion has Chocolatey >= 0.9.8.24 installed, this function calls :mod:`chocolatey.install <salt.modules.chocolatey.install>` instead, as ``installmissing`` is deprecated as of that ver...
[ "Instructs", "Chocolatey", "to", "install", "a", "package", "if", "it", "doesn", "t", "already", "exist", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L563-L611
train
saltstack/salt
salt/modules/chocolatey.py
install_python
def install_python(name, version=None, install_args=None, override_args=False): ''' Instructs Chocolatey to install a package via Python's easy_install. name The name of the package to be installed. Only accepts a single argument. version Install a specific version of the package. Defa...
python
def install_python(name, version=None, install_args=None, override_args=False): ''' Instructs Chocolatey to install a package via Python's easy_install. name The name of the package to be installed. Only accepts a single argument. version Install a specific version of the package. Defa...
[ "def", "install_python", "(", "name", ",", "version", "=", "None", ",", "install_args", "=", "None", ",", "override_args", "=", "False", ")", ":", "return", "install", "(", "name", ",", "version", "=", "version", ",", "source", "=", "'python'", ",", "ins...
Instructs Chocolatey to install a package via Python's easy_install. name The name of the package to be installed. Only accepts a single argument. version Install a specific version of the package. Defaults to latest version available. install_args A list of install argume...
[ "Instructs", "Chocolatey", "to", "install", "a", "package", "via", "Python", "s", "easy_install", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L614-L647
train
saltstack/salt
salt/modules/chocolatey.py
install_webpi
def install_webpi(name, install_args=None, override_args=False): ''' Instructs Chocolatey to install a package via the Microsoft Web PI service. name The name of the package to be installed. Only accepts a single argument. install_args A list of install arguments you want to pass to th...
python
def install_webpi(name, install_args=None, override_args=False): ''' Instructs Chocolatey to install a package via the Microsoft Web PI service. name The name of the package to be installed. Only accepts a single argument. install_args A list of install arguments you want to pass to th...
[ "def", "install_webpi", "(", "name", ",", "install_args", "=", "None", ",", "override_args", "=", "False", ")", ":", "return", "install", "(", "name", ",", "source", "=", "'webpi'", ",", "install_args", "=", "install_args", ",", "override_args", "=", "overri...
Instructs Chocolatey to install a package via the Microsoft Web PI service. name The name of the package to be installed. Only accepts a single argument. install_args A list of install arguments you want to pass to the installation process i.e product key or feature list override_...
[ "Instructs", "Chocolatey", "to", "install", "a", "package", "via", "the", "Microsoft", "Web", "PI", "service", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L667-L694
train
saltstack/salt
salt/modules/chocolatey.py
uninstall
def uninstall(name, version=None, uninstall_args=None, override_args=False): ''' Instructs Chocolatey to uninstall a package. name The name of the package to be uninstalled. Only accepts a single argument. version Uninstalls a specific version of the package. Defaults to latest...
python
def uninstall(name, version=None, uninstall_args=None, override_args=False): ''' Instructs Chocolatey to uninstall a package. name The name of the package to be uninstalled. Only accepts a single argument. version Uninstalls a specific version of the package. Defaults to latest...
[ "def", "uninstall", "(", "name", ",", "version", "=", "None", ",", "uninstall_args", "=", "None", ",", "override_args", "=", "False", ")", ":", "choc_path", "=", "_find_chocolatey", "(", "__context__", ",", "__salt__", ")", "# chocolatey helpfully only supports a ...
Instructs Chocolatey to uninstall a package. name The name of the package to be uninstalled. Only accepts a single argument. version Uninstalls a specific version of the package. Defaults to latest version installed. uninstall_args A list of uninstall arguments you...
[ "Instructs", "Chocolatey", "to", "uninstall", "a", "package", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L697-L744
train
saltstack/salt
salt/modules/chocolatey.py
upgrade
def upgrade(name, version=None, source=None, force=False, pre_versions=False, install_args=None, override_args=False, force_x86=False, package_args=None): ''' .. versionadded:: 2016.3.4 Instructs Chocolatey to u...
python
def upgrade(name, version=None, source=None, force=False, pre_versions=False, install_args=None, override_args=False, force_x86=False, package_args=None): ''' .. versionadded:: 2016.3.4 Instructs Chocolatey to u...
[ "def", "upgrade", "(", "name", ",", "version", "=", "None", ",", "source", "=", "None", ",", "force", "=", "False", ",", "pre_versions", "=", "False", ",", "install_args", "=", "None", ",", "override_args", "=", "False", ",", "force_x86", "=", "False", ...
.. versionadded:: 2016.3.4 Instructs Chocolatey to upgrade packages on the system. (update is being deprecated). This command will install the package if not installed. Args: name (str): The name of the package to update, or "all" to update everything installed on the syst...
[ "..", "versionadded", "::", "2016", ".", "3", ".", "4" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L747-L839
train
saltstack/salt
salt/modules/chocolatey.py
update
def update(name, source=None, pre_versions=False): ''' Instructs Chocolatey to update packages on the system. name The name of the package to update, or "all" to update everything installed on the system. source Chocolatey repository (directory, share or remote URL feed) the pa...
python
def update(name, source=None, pre_versions=False): ''' Instructs Chocolatey to update packages on the system. name The name of the package to update, or "all" to update everything installed on the system. source Chocolatey repository (directory, share or remote URL feed) the pa...
[ "def", "update", "(", "name", ",", "source", "=", "None", ",", "pre_versions", "=", "False", ")", ":", "# chocolatey helpfully only supports a single package argument", "choc_path", "=", "_find_chocolatey", "(", "__context__", ",", "__salt__", ")", "if", "_LooseVersio...
Instructs Chocolatey to update packages on the system. name The name of the package to update, or "all" to update everything installed on the system. source Chocolatey repository (directory, share or remote URL feed) the package comes from. Defaults to the official Chocolatey f...
[ "Instructs", "Chocolatey", "to", "update", "packages", "on", "the", "system", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L842-L887
train
saltstack/salt
salt/modules/chocolatey.py
version
def version(name, check_remote=False, source=None, pre_versions=False): ''' Instructs Chocolatey to check an installed package version, and optionally compare it to one available from a remote feed. Args: name (str): The name of the package to check. Required. check_remote...
python
def version(name, check_remote=False, source=None, pre_versions=False): ''' Instructs Chocolatey to check an installed package version, and optionally compare it to one available from a remote feed. Args: name (str): The name of the package to check. Required. check_remote...
[ "def", "version", "(", "name", ",", "check_remote", "=", "False", ",", "source", "=", "None", ",", "pre_versions", "=", "False", ")", ":", "installed", "=", "list_", "(", "narrow", "=", "name", ",", "local_only", "=", "True", ")", "installed", "=", "{"...
Instructs Chocolatey to check an installed package version, and optionally compare it to one available from a remote feed. Args: name (str): The name of the package to check. Required. check_remote (bool): Get the version number of the latest package from the remote fe...
[ "Instructs", "Chocolatey", "to", "check", "an", "installed", "package", "version", "and", "optionally", "compare", "it", "to", "one", "available", "from", "a", "remote", "feed", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L890-L945
train
saltstack/salt
salt/modules/chocolatey.py
add_source
def add_source(name, source_location, username=None, password=None): ''' Instructs Chocolatey to add a source. name The name of the source to be added as a chocolatey repository. source Location of the source you want to work with. username Provide username for chocolatey ...
python
def add_source(name, source_location, username=None, password=None): ''' Instructs Chocolatey to add a source. name The name of the source to be added as a chocolatey repository. source Location of the source you want to work with. username Provide username for chocolatey ...
[ "def", "add_source", "(", "name", ",", "source_location", ",", "username", "=", "None", ",", "password", "=", "None", ")", ":", "choc_path", "=", "_find_chocolatey", "(", "__context__", ",", "__salt__", ")", "cmd", "=", "[", "choc_path", ",", "'sources'", ...
Instructs Chocolatey to add a source. name The name of the source to be added as a chocolatey repository. source Location of the source you want to work with. username Provide username for chocolatey sources that need authentication credentials. password Provi...
[ "Instructs", "Chocolatey", "to", "add", "a", "source", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L948-L987
train
saltstack/salt
salt/modules/chocolatey.py
_change_source_state
def _change_source_state(name, state): ''' Instructs Chocolatey to change the state of a source. name Name of the repository to affect. state State in which you want the chocolatey repository. ''' choc_path = _find_chocolatey(__context__, __salt__) cmd = [choc_path, 'sourc...
python
def _change_source_state(name, state): ''' Instructs Chocolatey to change the state of a source. name Name of the repository to affect. state State in which you want the chocolatey repository. ''' choc_path = _find_chocolatey(__context__, __salt__) cmd = [choc_path, 'sourc...
[ "def", "_change_source_state", "(", "name", ",", "state", ")", ":", "choc_path", "=", "_find_chocolatey", "(", "__context__", ",", "__salt__", ")", "cmd", "=", "[", "choc_path", ",", "'source'", ",", "state", ",", "'--name'", ",", "name", "]", "result", "=...
Instructs Chocolatey to change the state of a source. name Name of the repository to affect. state State in which you want the chocolatey repository.
[ "Instructs", "Chocolatey", "to", "change", "the", "state", "of", "a", "source", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/chocolatey.py#L990-L1010
train
saltstack/salt
salt/modules/layman.py
add
def add(overlay): ''' Add the given overlay from the cached remote list to your locally installed overlays. Specify 'ALL' to add all overlays from the remote list. Return a list of the new overlay(s) added: CLI Example: .. code-block:: bash salt '*' layman.add <overlay name> ...
python
def add(overlay): ''' Add the given overlay from the cached remote list to your locally installed overlays. Specify 'ALL' to add all overlays from the remote list. Return a list of the new overlay(s) added: CLI Example: .. code-block:: bash salt '*' layman.add <overlay name> ...
[ "def", "add", "(", "overlay", ")", ":", "ret", "=", "list", "(", ")", "old_overlays", "=", "list_local", "(", ")", "cmd", "=", "'layman --quietness=0 --add {0}'", ".", "format", "(", "overlay", ")", "add_attempt", "=", "__salt__", "[", "'cmd.run_all'", "]", ...
Add the given overlay from the cached remote list to your locally installed overlays. Specify 'ALL' to add all overlays from the remote list. Return a list of the new overlay(s) added: CLI Example: .. code-block:: bash salt '*' layman.add <overlay name>
[ "Add", "the", "given", "overlay", "from", "the", "cached", "remote", "list", "to", "your", "locally", "installed", "overlays", ".", "Specify", "ALL", "to", "add", "all", "overlays", "from", "the", "remote", "list", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/layman.py#L33-L65
train
saltstack/salt
salt/modules/layman.py
delete
def delete(overlay): ''' Remove the given overlay from the your locally installed overlays. Specify 'ALL' to remove all overlays. Return a list of the overlays(s) that were removed: CLI Example: .. code-block:: bash salt '*' layman.delete <overlay name> ''' ret = list() o...
python
def delete(overlay): ''' Remove the given overlay from the your locally installed overlays. Specify 'ALL' to remove all overlays. Return a list of the overlays(s) that were removed: CLI Example: .. code-block:: bash salt '*' layman.delete <overlay name> ''' ret = list() o...
[ "def", "delete", "(", "overlay", ")", ":", "ret", "=", "list", "(", ")", "old_overlays", "=", "list_local", "(", ")", "cmd", "=", "'layman --quietness=0 --delete {0}'", ".", "format", "(", "overlay", ")", "delete_attempt", "=", "__salt__", "[", "'cmd.run_all'"...
Remove the given overlay from the your locally installed overlays. Specify 'ALL' to remove all overlays. Return a list of the overlays(s) that were removed: CLI Example: .. code-block:: bash salt '*' layman.delete <overlay name>
[ "Remove", "the", "given", "overlay", "from", "the", "your", "locally", "installed", "overlays", ".", "Specify", "ALL", "to", "remove", "all", "overlays", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/layman.py#L68-L98
train
saltstack/salt
salt/modules/layman.py
list_local
def list_local(): ''' List the locally installed overlays. Return a list of installed overlays: CLI Example: .. code-block:: bash salt '*' layman.list_local ''' cmd = 'layman --quietness=1 --list-local --nocolor' out = __salt__['cmd.run'](cmd, python_shell=False).split('\n') ...
python
def list_local(): ''' List the locally installed overlays. Return a list of installed overlays: CLI Example: .. code-block:: bash salt '*' layman.list_local ''' cmd = 'layman --quietness=1 --list-local --nocolor' out = __salt__['cmd.run'](cmd, python_shell=False).split('\n') ...
[ "def", "list_local", "(", ")", ":", "cmd", "=", "'layman --quietness=1 --list-local --nocolor'", "out", "=", "__salt__", "[", "'cmd.run'", "]", "(", "cmd", ",", "python_shell", "=", "False", ")", ".", "split", "(", "'\\n'", ")", "ret", "=", "[", "line", "....
List the locally installed overlays. Return a list of installed overlays: CLI Example: .. code-block:: bash salt '*' layman.list_local
[ "List", "the", "locally", "installed", "overlays", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/layman.py#L119-L134
train
saltstack/salt
salt/auth/django.py
__django_auth_setup
def __django_auth_setup(): ''' Prepare the connection to the Django authentication framework ''' if django.VERSION >= (1, 7): django.setup() global DJANGO_AUTH_CLASS if DJANGO_AUTH_CLASS is not None: return # Versions 1.7 and later of Django don't pull models until # t...
python
def __django_auth_setup(): ''' Prepare the connection to the Django authentication framework ''' if django.VERSION >= (1, 7): django.setup() global DJANGO_AUTH_CLASS if DJANGO_AUTH_CLASS is not None: return # Versions 1.7 and later of Django don't pull models until # t...
[ "def", "__django_auth_setup", "(", ")", ":", "if", "django", ".", "VERSION", ">=", "(", "1", ",", "7", ")", ":", "django", ".", "setup", "(", ")", "global", "DJANGO_AUTH_CLASS", "if", "DJANGO_AUTH_CLASS", "is", "not", "None", ":", "return", "# Versions 1.7...
Prepare the connection to the Django authentication framework
[ "Prepare", "the", "connection", "to", "the", "Django", "authentication", "framework" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/auth/django.py#L93-L116
train
saltstack/salt
salt/auth/django.py
auth
def auth(username, password): ''' Simple Django auth ''' django_auth_path = __opts__['django_auth_path'] if django_auth_path not in sys.path: sys.path.append(django_auth_path) os.environ.setdefault('DJANGO_SETTINGS_MODULE', __opts__['django_auth_settings']) __django_auth_setup() ...
python
def auth(username, password): ''' Simple Django auth ''' django_auth_path = __opts__['django_auth_path'] if django_auth_path not in sys.path: sys.path.append(django_auth_path) os.environ.setdefault('DJANGO_SETTINGS_MODULE', __opts__['django_auth_settings']) __django_auth_setup() ...
[ "def", "auth", "(", "username", ",", "password", ")", ":", "django_auth_path", "=", "__opts__", "[", "'django_auth_path'", "]", "if", "django_auth_path", "not", "in", "sys", ".", "path", ":", "sys", ".", "path", ".", "append", "(", "django_auth_path", ")", ...
Simple Django auth
[ "Simple", "Django", "auth" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/auth/django.py#L119-L144
train
saltstack/salt
salt/matchers/confirm_top.py
confirm_top
def confirm_top(match, data, nodegroups=None): ''' Takes the data passed to a top file environment and determines if the data matches this minion ''' matcher = 'compound' if not data: log.error('Received bad data when setting the match from the top ' 'file') ret...
python
def confirm_top(match, data, nodegroups=None): ''' Takes the data passed to a top file environment and determines if the data matches this minion ''' matcher = 'compound' if not data: log.error('Received bad data when setting the match from the top ' 'file') ret...
[ "def", "confirm_top", "(", "match", ",", "data", ",", "nodegroups", "=", "None", ")", ":", "matcher", "=", "'compound'", "if", "not", "data", ":", "log", ".", "error", "(", "'Received bad data when setting the match from the top '", "'file'", ")", "return", "Fal...
Takes the data passed to a top file environment and determines if the data matches this minion
[ "Takes", "the", "data", "passed", "to", "a", "top", "file", "environment", "and", "determines", "if", "the", "data", "matches", "this", "minion" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/matchers/confirm_top.py#L15-L36
train
saltstack/salt
salt/modules/win_servermanager.py
list_installed
def list_installed(): ''' List installed features. Supported on Windows Server 2008 and Windows 8 and newer. Returns: dict: A dictionary of installed features CLI Example: .. code-block:: bash salt '*' win_servermanager.list_installed ''' cmd = 'Get-WindowsFeature ' \...
python
def list_installed(): ''' List installed features. Supported on Windows Server 2008 and Windows 8 and newer. Returns: dict: A dictionary of installed features CLI Example: .. code-block:: bash salt '*' win_servermanager.list_installed ''' cmd = 'Get-WindowsFeature ' \...
[ "def", "list_installed", "(", ")", ":", "cmd", "=", "'Get-WindowsFeature '", "'-ErrorAction SilentlyContinue '", "'-WarningAction SilentlyContinue '", "'| Select DisplayName,Name,Installed'", "features", "=", "_pshell_json", "(", "cmd", ")", "ret", "=", "{", "}", "for", "...
List installed features. Supported on Windows Server 2008 and Windows 8 and newer. Returns: dict: A dictionary of installed features CLI Example: .. code-block:: bash salt '*' win_servermanager.list_installed
[ "List", "installed", "features", ".", "Supported", "on", "Windows", "Server", "2008", "and", "Windows", "8", "and", "newer", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_servermanager.py#L108-L133
train
saltstack/salt
salt/modules/win_servermanager.py
install
def install(feature, recurse=False, restart=False, source=None, exclude=None): r''' Install a feature .. note:: Some features require reboot after un/installation, if so until the server is restarted other features can not be installed! .. note:: Some features take a long time ...
python
def install(feature, recurse=False, restart=False, source=None, exclude=None): r''' Install a feature .. note:: Some features require reboot after un/installation, if so until the server is restarted other features can not be installed! .. note:: Some features take a long time ...
[ "def", "install", "(", "feature", ",", "recurse", "=", "False", ",", "restart", "=", "False", ",", "source", "=", "None", ",", "exclude", "=", "None", ")", ":", "# If it is a list of features, make it a comma delimited string", "if", "isinstance", "(", "feature", ...
r''' Install a feature .. note:: Some features require reboot after un/installation, if so until the server is restarted other features can not be installed! .. note:: Some features take a long time to complete un/installation, set -t with a long timeout Args: ...
[ "r", "Install", "a", "feature" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_servermanager.py#L136-L298
train
saltstack/salt
salt/modules/win_servermanager.py
remove
def remove(feature, remove_payload=False, restart=False): r''' Remove an installed feature .. note:: Some features require a reboot after installation/uninstallation. If one of these features are modified, then other features cannot be installed until the server is restarted. Additi...
python
def remove(feature, remove_payload=False, restart=False): r''' Remove an installed feature .. note:: Some features require a reboot after installation/uninstallation. If one of these features are modified, then other features cannot be installed until the server is restarted. Additi...
[ "def", "remove", "(", "feature", ",", "remove_payload", "=", "False", ",", "restart", "=", "False", ")", ":", "# If it is a list of features, make it a comma delimited string", "if", "isinstance", "(", "feature", ",", "list", ")", ":", "feature", "=", "','", ".", ...
r''' Remove an installed feature .. note:: Some features require a reboot after installation/uninstallation. If one of these features are modified, then other features cannot be installed until the server is restarted. Additionally, some features take a while to complete install...
[ "r", "Remove", "an", "installed", "feature" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/win_servermanager.py#L301-L407
train
saltstack/salt
salt/modules/iwtools.py
scan
def scan(iface, style=None): ''' List networks on a wireless interface CLI Examples: salt minion iwtools.scan wlp3s0 salt minion iwtools.scan wlp3s0 list ''' if not _valid_iface(iface): raise SaltInvocationError( 'The interface specified is not valid' ) ...
python
def scan(iface, style=None): ''' List networks on a wireless interface CLI Examples: salt minion iwtools.scan wlp3s0 salt minion iwtools.scan wlp3s0 list ''' if not _valid_iface(iface): raise SaltInvocationError( 'The interface specified is not valid' ) ...
[ "def", "scan", "(", "iface", ",", "style", "=", "None", ")", ":", "if", "not", "_valid_iface", "(", "iface", ")", ":", "raise", "SaltInvocationError", "(", "'The interface specified is not valid'", ")", "out", "=", "__salt__", "[", "'cmd.run'", "]", "(", "'i...
List networks on a wireless interface CLI Examples: salt minion iwtools.scan wlp3s0 salt minion iwtools.scan wlp3s0 list
[ "List", "networks", "on", "a", "wireless", "interface" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/iwtools.py#L28-L75
train
saltstack/salt
salt/modules/iwtools.py
set_mode
def set_mode(iface, mode): ''' List networks on a wireless interface CLI Example: salt minion iwtools.set_mode wlp3s0 Managed ''' if not _valid_iface(iface): raise SaltInvocationError( 'The interface specified is not valid' ) valid_modes = ('Managed', 'Ad-H...
python
def set_mode(iface, mode): ''' List networks on a wireless interface CLI Example: salt minion iwtools.set_mode wlp3s0 Managed ''' if not _valid_iface(iface): raise SaltInvocationError( 'The interface specified is not valid' ) valid_modes = ('Managed', 'Ad-H...
[ "def", "set_mode", "(", "iface", ",", "mode", ")", ":", "if", "not", "_valid_iface", "(", "iface", ")", ":", "raise", "SaltInvocationError", "(", "'The interface specified is not valid'", ")", "valid_modes", "=", "(", "'Managed'", ",", "'Ad-Hoc'", ",", "'Master'...
List networks on a wireless interface CLI Example: salt minion iwtools.set_mode wlp3s0 Managed
[ "List", "networks", "on", "a", "wireless", "interface" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/iwtools.py#L78-L100
train
saltstack/salt
salt/modules/iwtools.py
list_interfaces
def list_interfaces(style=None): ''' List all of the wireless interfaces CLI Example: salt minion iwtools.list_interfaces ''' ret = {} tmp = None iface = None out = __salt__['cmd.run']('iwconfig') for line in out.splitlines(): if not line: continue ...
python
def list_interfaces(style=None): ''' List all of the wireless interfaces CLI Example: salt minion iwtools.list_interfaces ''' ret = {} tmp = None iface = None out = __salt__['cmd.run']('iwconfig') for line in out.splitlines(): if not line: continue ...
[ "def", "list_interfaces", "(", "style", "=", "None", ")", ":", "ret", "=", "{", "}", "tmp", "=", "None", "iface", "=", "None", "out", "=", "__salt__", "[", "'cmd.run'", "]", "(", "'iwconfig'", ")", "for", "line", "in", "out", ".", "splitlines", "(", ...
List all of the wireless interfaces CLI Example: salt minion iwtools.list_interfaces
[ "List", "all", "of", "the", "wireless", "interfaces" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/iwtools.py#L113-L155
train
saltstack/salt
salt/beacons/smartos_vmadm.py
validate
def validate(config): ''' Validate the beacon configuration ''' vcfg_ret = True vcfg_msg = 'Valid beacon configuration' if not isinstance(config, list): vcfg_ret = False vcfg_msg = 'Configuration for vmadm beacon must be a list!' return vcfg_ret, vcfg_msg
python
def validate(config): ''' Validate the beacon configuration ''' vcfg_ret = True vcfg_msg = 'Valid beacon configuration' if not isinstance(config, list): vcfg_ret = False vcfg_msg = 'Configuration for vmadm beacon must be a list!' return vcfg_ret, vcfg_msg
[ "def", "validate", "(", "config", ")", ":", "vcfg_ret", "=", "True", "vcfg_msg", "=", "'Valid beacon configuration'", "if", "not", "isinstance", "(", "config", ",", "list", ")", ":", "vcfg_ret", "=", "False", "vcfg_msg", "=", "'Configuration for vmadm beacon must ...
Validate the beacon configuration
[ "Validate", "the", "beacon", "configuration" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/beacons/smartos_vmadm.py#L55-L66
train
saltstack/salt
salt/beacons/smartos_vmadm.py
beacon
def beacon(config): ''' Poll vmadm for changes ''' ret = [] # NOTE: lookup current images current_vms = __salt__['vmadm.list']( keyed=True, order='uuid,state,alias,hostname,dns_domain', ) # NOTE: apply configuration if VMADM_STATE['first_run']: log.info('App...
python
def beacon(config): ''' Poll vmadm for changes ''' ret = [] # NOTE: lookup current images current_vms = __salt__['vmadm.list']( keyed=True, order='uuid,state,alias,hostname,dns_domain', ) # NOTE: apply configuration if VMADM_STATE['first_run']: log.info('App...
[ "def", "beacon", "(", "config", ")", ":", "ret", "=", "[", "]", "# NOTE: lookup current images", "current_vms", "=", "__salt__", "[", "'vmadm.list'", "]", "(", "keyed", "=", "True", ",", "order", "=", "'uuid,state,alias,hostname,dns_domain'", ",", ")", "# NOTE: ...
Poll vmadm for changes
[ "Poll", "vmadm", "for", "changes" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/beacons/smartos_vmadm.py#L69-L139
train
saltstack/salt
salt/modules/mssql.py
tsql_query
def tsql_query(query, **kwargs): ''' Run a SQL query and return query result as list of tuples, or a list of dictionaries if as_dict was passed, or an empty list if no data is available. CLI Example: .. code-block:: bash salt minion mssql.tsql_query 'SELECT @@version as version' as_dict=True ...
python
def tsql_query(query, **kwargs): ''' Run a SQL query and return query result as list of tuples, or a list of dictionaries if as_dict was passed, or an empty list if no data is available. CLI Example: .. code-block:: bash salt minion mssql.tsql_query 'SELECT @@version as version' as_dict=True ...
[ "def", "tsql_query", "(", "query", ",", "*", "*", "kwargs", ")", ":", "try", ":", "cur", "=", "_get_connection", "(", "*", "*", "kwargs", ")", ".", "cursor", "(", ")", "cur", ".", "execute", "(", "query", ")", "# Making sure the result is JSON serializable...
Run a SQL query and return query result as list of tuples, or a list of dictionaries if as_dict was passed, or an empty list if no data is available. CLI Example: .. code-block:: bash salt minion mssql.tsql_query 'SELECT @@version as version' as_dict=True
[ "Run", "a", "SQL", "query", "and", "return", "query", "result", "as", "list", "of", "tuples", "or", "a", "list", "of", "dictionaries", "if", "as_dict", "was", "passed", "or", "an", "empty", "list", "if", "no", "data", "is", "available", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mssql.py#L74-L91
train
saltstack/salt
salt/modules/mssql.py
db_create
def db_create(database, containment='NONE', new_database_options=None, **kwargs): ''' Creates a new database. Does not update options of existing databases. new_database_options can only be a list of strings CLI Example: .. code-block:: bash salt minion mssql.db_create DB_NAME '''...
python
def db_create(database, containment='NONE', new_database_options=None, **kwargs): ''' Creates a new database. Does not update options of existing databases. new_database_options can only be a list of strings CLI Example: .. code-block:: bash salt minion mssql.db_create DB_NAME '''...
[ "def", "db_create", "(", "database", ",", "containment", "=", "'NONE'", ",", "new_database_options", "=", "None", ",", "*", "*", "kwargs", ")", ":", "if", "containment", "not", "in", "[", "'NONE'", ",", "'PARTIAL'", "]", ":", "return", "'CONTAINMENT can be o...
Creates a new database. Does not update options of existing databases. new_database_options can only be a list of strings CLI Example: .. code-block:: bash salt minion mssql.db_create DB_NAME
[ "Creates", "a", "new", "database", ".", "Does", "not", "update", "options", "of", "existing", "databases", ".", "new_database_options", "can", "only", "be", "a", "list", "of", "strings" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mssql.py#L134-L164
train
saltstack/salt
salt/modules/mssql.py
db_remove
def db_remove(database_name, **kwargs): ''' Drops a specific database from the MS SQL server. It will not drop any of 'master', 'model', 'msdb' or 'tempdb'. CLI Example: .. code-block:: bash salt minion mssql.db_remove database_name='DBNAME' ''' try: if db_exists(database_...
python
def db_remove(database_name, **kwargs): ''' Drops a specific database from the MS SQL server. It will not drop any of 'master', 'model', 'msdb' or 'tempdb'. CLI Example: .. code-block:: bash salt minion mssql.db_remove database_name='DBNAME' ''' try: if db_exists(database_...
[ "def", "db_remove", "(", "database_name", ",", "*", "*", "kwargs", ")", ":", "try", ":", "if", "db_exists", "(", "database_name", ",", "*", "*", "kwargs", ")", "and", "database_name", "not", "in", "[", "'master'", ",", "'model'", ",", "'msdb'", ",", "'...
Drops a specific database from the MS SQL server. It will not drop any of 'master', 'model', 'msdb' or 'tempdb'. CLI Example: .. code-block:: bash salt minion mssql.db_remove database_name='DBNAME'
[ "Drops", "a", "specific", "database", "from", "the", "MS", "SQL", "server", ".", "It", "will", "not", "drop", "any", "of", "master", "model", "msdb", "or", "tempdb", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mssql.py#L167-L191
train
saltstack/salt
salt/modules/mssql.py
role_exists
def role_exists(role, **kwargs): ''' Checks if a role exists. CLI Example: .. code-block:: bash salt minion mssql.role_exists db_owner ''' # We should get one, and only one row return len(tsql_query(query='sp_helprole "{0}"'.format(role), as_dict=True, **kwargs)) == 1
python
def role_exists(role, **kwargs): ''' Checks if a role exists. CLI Example: .. code-block:: bash salt minion mssql.role_exists db_owner ''' # We should get one, and only one row return len(tsql_query(query='sp_helprole "{0}"'.format(role), as_dict=True, **kwargs)) == 1
[ "def", "role_exists", "(", "role", ",", "*", "*", "kwargs", ")", ":", "# We should get one, and only one row", "return", "len", "(", "tsql_query", "(", "query", "=", "'sp_helprole \"{0}\"'", ".", "format", "(", "role", ")", ",", "as_dict", "=", "True", ",", ...
Checks if a role exists. CLI Example: .. code-block:: bash salt minion mssql.role_exists db_owner
[ "Checks", "if", "a", "role", "exists", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mssql.py#L208-L220
train
saltstack/salt
salt/modules/mssql.py
role_create
def role_create(role, owner=None, grants=None, **kwargs): ''' Creates a new database role. If no owner is specified, the role will be owned by the user that executes CREATE ROLE, which is the user argument or mssql.user option. grants is list of strings. CLI Example: .. code-block:: bash ...
python
def role_create(role, owner=None, grants=None, **kwargs): ''' Creates a new database role. If no owner is specified, the role will be owned by the user that executes CREATE ROLE, which is the user argument or mssql.user option. grants is list of strings. CLI Example: .. code-block:: bash ...
[ "def", "role_create", "(", "role", ",", "owner", "=", "None", ",", "grants", "=", "None", ",", "*", "*", "kwargs", ")", ":", "if", "not", "grants", ":", "grants", "=", "[", "]", "sql", "=", "'CREATE ROLE {0}'", ".", "format", "(", "role", ")", "if"...
Creates a new database role. If no owner is specified, the role will be owned by the user that executes CREATE ROLE, which is the user argument or mssql.user option. grants is list of strings. CLI Example: .. code-block:: bash salt minion mssql.role_create role=product01 owner=sysdba gran...
[ "Creates", "a", "new", "database", "role", ".", "If", "no", "owner", "is", "specified", "the", "role", "will", "be", "owned", "by", "the", "user", "that", "executes", "CREATE", "ROLE", "which", "is", "the", "user", "argument", "or", "mssql", ".", "user",...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mssql.py#L223-L257
train
saltstack/salt
salt/modules/mssql.py
role_remove
def role_remove(role, **kwargs): ''' Remove a database role. CLI Example: .. code-block:: bash salt minion mssql.role_create role=test_role01 ''' try: conn = _get_connection(**kwargs) conn.autocommit(True) cur = conn.cursor() cur.execute('DROP ROLE {0}'...
python
def role_remove(role, **kwargs): ''' Remove a database role. CLI Example: .. code-block:: bash salt minion mssql.role_create role=test_role01 ''' try: conn = _get_connection(**kwargs) conn.autocommit(True) cur = conn.cursor() cur.execute('DROP ROLE {0}'...
[ "def", "role_remove", "(", "role", ",", "*", "*", "kwargs", ")", ":", "try", ":", "conn", "=", "_get_connection", "(", "*", "*", "kwargs", ")", "conn", ".", "autocommit", "(", "True", ")", "cur", "=", "conn", ".", "cursor", "(", ")", "cur", ".", ...
Remove a database role. CLI Example: .. code-block:: bash salt minion mssql.role_create role=test_role01
[ "Remove", "a", "database", "role", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mssql.py#L260-L279
train
saltstack/salt
salt/modules/mssql.py
login_exists
def login_exists(login, domain='', **kwargs): ''' Find if a login exists in the MS SQL server. domain, if provided, will be prepended to login CLI Example: .. code-block:: bash salt minion mssql.login_exists 'LOGIN' ''' if domain: login = '{0}\\{1}'.format(domain, login) ...
python
def login_exists(login, domain='', **kwargs): ''' Find if a login exists in the MS SQL server. domain, if provided, will be prepended to login CLI Example: .. code-block:: bash salt minion mssql.login_exists 'LOGIN' ''' if domain: login = '{0}\\{1}'.format(domain, login) ...
[ "def", "login_exists", "(", "login", ",", "domain", "=", "''", ",", "*", "*", "kwargs", ")", ":", "if", "domain", ":", "login", "=", "'{0}\\\\{1}'", ".", "format", "(", "domain", ",", "login", ")", "try", ":", "# We should get one, and only one row", "retu...
Find if a login exists in the MS SQL server. domain, if provided, will be prepended to login CLI Example: .. code-block:: bash salt minion mssql.login_exists 'LOGIN'
[ "Find", "if", "a", "login", "exists", "in", "the", "MS", "SQL", "server", ".", "domain", "if", "provided", "will", "be", "prepended", "to", "login" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mssql.py#L282-L300
train
saltstack/salt
salt/modules/mssql.py
login_create
def login_create(login, new_login_password=None, new_login_domain='', new_login_roles=None, new_login_options=None, **kwargs): ''' Creates a new login. Does not update password of existing logins. For Windows authentication, provide ``new_login_domain``. For SQL Server authentication, prvide ``new_lo...
python
def login_create(login, new_login_password=None, new_login_domain='', new_login_roles=None, new_login_options=None, **kwargs): ''' Creates a new login. Does not update password of existing logins. For Windows authentication, provide ``new_login_domain``. For SQL Server authentication, prvide ``new_lo...
[ "def", "login_create", "(", "login", ",", "new_login_password", "=", "None", ",", "new_login_domain", "=", "''", ",", "new_login_roles", "=", "None", ",", "new_login_options", "=", "None", ",", "*", "*", "kwargs", ")", ":", "# One and only one of password and doma...
Creates a new login. Does not update password of existing logins. For Windows authentication, provide ``new_login_domain``. For SQL Server authentication, prvide ``new_login_password``. Since hashed passwords are *varbinary* values, if the ``new_login_password`` is 'int / long', it will be considere...
[ "Creates", "a", "new", "login", ".", "Does", "not", "update", "password", "of", "existing", "logins", ".", "For", "Windows", "authentication", "provide", "new_login_domain", ".", "For", "SQL", "Server", "authentication", "prvide", "new_login_password", ".", "Since...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mssql.py#L303-L359
train
saltstack/salt
salt/modules/mssql.py
login_remove
def login_remove(login, **kwargs): ''' Removes an login. CLI Example: .. code-block:: bash salt minion mssql.login_remove LOGINNAME ''' try: conn = _get_connection(**kwargs) conn.autocommit(True) cur = conn.cursor() cur.execute("DROP LOGIN [{0}]".format...
python
def login_remove(login, **kwargs): ''' Removes an login. CLI Example: .. code-block:: bash salt minion mssql.login_remove LOGINNAME ''' try: conn = _get_connection(**kwargs) conn.autocommit(True) cur = conn.cursor() cur.execute("DROP LOGIN [{0}]".format...
[ "def", "login_remove", "(", "login", ",", "*", "*", "kwargs", ")", ":", "try", ":", "conn", "=", "_get_connection", "(", "*", "*", "kwargs", ")", "conn", ".", "autocommit", "(", "True", ")", "cur", "=", "conn", ".", "cursor", "(", ")", "cur", ".", ...
Removes an login. CLI Example: .. code-block:: bash salt minion mssql.login_remove LOGINNAME
[ "Removes", "an", "login", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mssql.py#L362-L381
train
saltstack/salt
salt/modules/mssql.py
user_exists
def user_exists(username, domain='', database=None, **kwargs): ''' Find if an user exists in a specific database on the MS SQL server. domain, if provided, will be prepended to username CLI Example: .. code-block:: bash salt minion mssql.user_exists 'USERNAME' [database='DBNAME'] ''' ...
python
def user_exists(username, domain='', database=None, **kwargs): ''' Find if an user exists in a specific database on the MS SQL server. domain, if provided, will be prepended to username CLI Example: .. code-block:: bash salt minion mssql.user_exists 'USERNAME' [database='DBNAME'] ''' ...
[ "def", "user_exists", "(", "username", ",", "domain", "=", "''", ",", "database", "=", "None", ",", "*", "*", "kwargs", ")", ":", "if", "domain", ":", "username", "=", "'{0}\\\\{1}'", ".", "format", "(", "domain", ",", "username", ")", "if", "database"...
Find if an user exists in a specific database on the MS SQL server. domain, if provided, will be prepended to username CLI Example: .. code-block:: bash salt minion mssql.user_exists 'USERNAME' [database='DBNAME']
[ "Find", "if", "an", "user", "exists", "in", "a", "specific", "database", "on", "the", "MS", "SQL", "server", ".", "domain", "if", "provided", "will", "be", "prepended", "to", "username" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mssql.py#L384-L400
train
saltstack/salt
salt/modules/mssql.py
user_create
def user_create(username, login=None, domain='', database=None, roles=None, options=None, **kwargs): ''' Creates a new user. If login is not specified, the user will be created without a login. domain, if provided, will be prepended to username. options can only be a list of strings CLI Example: ...
python
def user_create(username, login=None, domain='', database=None, roles=None, options=None, **kwargs): ''' Creates a new user. If login is not specified, the user will be created without a login. domain, if provided, will be prepended to username. options can only be a list of strings CLI Example: ...
[ "def", "user_create", "(", "username", ",", "login", "=", "None", ",", "domain", "=", "''", ",", "database", "=", "None", ",", "roles", "=", "None", ",", "options", "=", "None", ",", "*", "*", "kwargs", ")", ":", "if", "domain", "and", "not", "logi...
Creates a new user. If login is not specified, the user will be created without a login. domain, if provided, will be prepended to username. options can only be a list of strings CLI Example: .. code-block:: bash salt minion mssql.user_create USERNAME database=DBNAME
[ "Creates", "a", "new", "user", ".", "If", "login", "is", "not", "specified", "the", "user", "will", "be", "created", "without", "a", "login", ".", "domain", "if", "provided", "will", "be", "prepended", "to", "username", ".", "options", "can", "only", "be...
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mssql.py#L416-L467
train
saltstack/salt
salt/modules/mssql.py
user_remove
def user_remove(username, **kwargs): ''' Removes an user. CLI Example: .. code-block:: bash salt minion mssql.user_remove USERNAME database=DBNAME ''' # 'database' argument is mandatory if 'database' not in kwargs: return False try: conn = _get_connection(**kwa...
python
def user_remove(username, **kwargs): ''' Removes an user. CLI Example: .. code-block:: bash salt minion mssql.user_remove USERNAME database=DBNAME ''' # 'database' argument is mandatory if 'database' not in kwargs: return False try: conn = _get_connection(**kwa...
[ "def", "user_remove", "(", "username", ",", "*", "*", "kwargs", ")", ":", "# 'database' argument is mandatory", "if", "'database'", "not", "in", "kwargs", ":", "return", "False", "try", ":", "conn", "=", "_get_connection", "(", "*", "*", "kwargs", ")", "conn...
Removes an user. CLI Example: .. code-block:: bash salt minion mssql.user_remove USERNAME database=DBNAME
[ "Removes", "an", "user", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/modules/mssql.py#L470-L492
train
saltstack/salt
salt/states/boto_cloudwatch_alarm.py
present
def present( name, attributes, region=None, key=None, keyid=None, profile=None): ''' Ensure the cloudwatch alarm exists. name Name of the alarm attributes A dict of key/value cloudwatch alarm attributes. region Region to conn...
python
def present( name, attributes, region=None, key=None, keyid=None, profile=None): ''' Ensure the cloudwatch alarm exists. name Name of the alarm attributes A dict of key/value cloudwatch alarm attributes. region Region to conn...
[ "def", "present", "(", "name", ",", "attributes", ",", "region", "=", "None", ",", "key", "=", "None", ",", "keyid", "=", "None", ",", "profile", "=", "None", ")", ":", "ret", "=", "{", "'name'", ":", "name", ",", "'result'", ":", "True", ",", "'...
Ensure the cloudwatch alarm exists. name Name of the alarm attributes A dict of key/value cloudwatch alarm attributes. region Region to connect to. key Secret key to be used. keyid Access key to be used. profile A dict with region, key and ke...
[ "Ensure", "the", "cloudwatch", "alarm", "exists", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/boto_cloudwatch_alarm.py#L73-L177
train
saltstack/salt
salt/states/docker_container.py
_format_comments
def _format_comments(ret, comments): ''' DRY code for joining comments together and conditionally adding a period at the end, and adding this comment string to the state return dict. ''' if isinstance(comments, six.string_types): ret['comment'] = comments else: ret['comment'] = '...
python
def _format_comments(ret, comments): ''' DRY code for joining comments together and conditionally adding a period at the end, and adding this comment string to the state return dict. ''' if isinstance(comments, six.string_types): ret['comment'] = comments else: ret['comment'] = '...
[ "def", "_format_comments", "(", "ret", ",", "comments", ")", ":", "if", "isinstance", "(", "comments", ",", "six", ".", "string_types", ")", ":", "ret", "[", "'comment'", "]", "=", "comments", "else", ":", "ret", "[", "'comment'", "]", "=", "'. '", "."...
DRY code for joining comments together and conditionally adding a period at the end, and adding this comment string to the state return dict.
[ "DRY", "code", "for", "joining", "comments", "together", "and", "conditionally", "adding", "a", "period", "at", "the", "end", "and", "adding", "this", "comment", "string", "to", "the", "state", "return", "dict", "." ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/docker_container.py#L79-L90
train
saltstack/salt
salt/states/docker_container.py
_check_diff
def _check_diff(changes): ''' Check the diff for signs of incorrect argument handling in previous releases, as discovered here: https://github.com/saltstack/salt/pull/39996#issuecomment-288025200 ''' for conf_dict in changes: if conf_dict == 'Networks': continue for ...
python
def _check_diff(changes): ''' Check the diff for signs of incorrect argument handling in previous releases, as discovered here: https://github.com/saltstack/salt/pull/39996#issuecomment-288025200 ''' for conf_dict in changes: if conf_dict == 'Networks': continue for ...
[ "def", "_check_diff", "(", "changes", ")", ":", "for", "conf_dict", "in", "changes", ":", "if", "conf_dict", "==", "'Networks'", ":", "continue", "for", "item", "in", "changes", "[", "conf_dict", "]", ":", "if", "changes", "[", "conf_dict", "]", "[", "it...
Check the diff for signs of incorrect argument handling in previous releases, as discovered here: https://github.com/saltstack/salt/pull/39996#issuecomment-288025200
[ "Check", "the", "diff", "for", "signs", "of", "incorrect", "argument", "handling", "in", "previous", "releases", "as", "discovered", "here", ":" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/docker_container.py#L93-L115
train
saltstack/salt
salt/states/docker_container.py
_parse_networks
def _parse_networks(networks): ''' Common logic for parsing the networks ''' networks = salt.utils.args.split_input(networks or []) if not networks: networks = {} else: # We don't want to recurse the repack, as the values of the kwargs # being passed when connecting to th...
python
def _parse_networks(networks): ''' Common logic for parsing the networks ''' networks = salt.utils.args.split_input(networks or []) if not networks: networks = {} else: # We don't want to recurse the repack, as the values of the kwargs # being passed when connecting to th...
[ "def", "_parse_networks", "(", "networks", ")", ":", "networks", "=", "salt", ".", "utils", ".", "args", ".", "split_input", "(", "networks", "or", "[", "]", ")", "if", "not", "networks", ":", "networks", "=", "{", "}", "else", ":", "# We don't want to r...
Common logic for parsing the networks
[ "Common", "logic", "for", "parsing", "the", "networks" ]
e8541fd6e744ab0df786c0f76102e41631f45d46
https://github.com/saltstack/salt/blob/e8541fd6e744ab0df786c0f76102e41631f45d46/salt/states/docker_container.py#L118-L186
train