INSTRUCTION stringlengths 1 8.43k | RESPONSE stringlengths 75 104k |
|---|---|
Checks for specific types in the state output. Raises an Exception in case particular rule is broken. | def content_check(self, result):
'''
Checks for specific types in the state output.
Raises an Exception in case particular rule is broken.
:param result:
:return:
'''
if not isinstance(result, dict):
err_msg = 'Malformed state return. Data must be a d... |
While comments as a list are allowed comments needs to be strings for backward compatibility. See such claim here: https:// github. com/ saltstack/ salt/ pull/ 43070 | def unify(self, result):
'''
While comments as a list are allowed,
comments needs to be strings for backward compatibility.
See such claim here: https://github.com/saltstack/salt/pull/43070
Rules applied:
- 'comment' is joined into a multi-line string, in case the valu... |
List all of the extended attributes on the given file/ directory | def list_(path, **kwargs):
'''
List all of the extended attributes on the given file/directory
:param str path: The file(s) to get attributes from
:param bool hex: Return the values with forced hexadecimal values
:return: A dictionary containing extended attributes and values for the
give... |
Read the given attributes on the given file/ directory | def read(path, attribute, **kwargs):
'''
Read the given attributes on the given file/directory
:param str path: The file to get attributes from
:param str attribute: The attribute to read
:param bool hex: Return the values with forced hexadecimal values
:return: A string containing the value... |
Removes the given attribute from the file | def delete(path, attribute):
'''
Removes the given attribute from the file
:param str path: The file(s) to get attributes from
:param str attribute: The attribute name to be deleted from the
file/directory
:return: True if successful, otherwise False
:rtype: bool
:raises: Command... |
Causes the all attributes on the file/ directory to be removed | def clear(path):
'''
Causes the all attributes on the file/directory to be removed
:param str path: The file(s) to get attributes from
:return: True if successful, otherwise False
:raises: CommandExecutionError on file not found or any other unknown error
CLI Example:
.. code-block:: ba... |
Get an auth token | def _get_token():
'''
Get an auth token
'''
username = __opts__.get('rallydev', {}).get('username', None)
password = __opts__.get('rallydev', {}).get('password', None)
path = 'https://rally1.rallydev.com/slm/webservice/v2.0/security/authorize'
result = salt.utils.http.query(
path,
... |
Make a web call to RallyDev. | def _query(action=None,
command=None,
args=None,
method='GET',
header_dict=None,
data=None):
'''
Make a web call to RallyDev.
'''
token = _get_token()
username = __opts__.get('rallydev', {}).get('username', None)
password = __opts__.get('ral... |
Query a type of record for one or more items. Requires a valid query string. See https:// rally1. rallydev. com/ slm/ doc/ webservice/ introduction. jsp for information on query syntax. | def query_item(name, query_string, order='Rank'):
'''
Query a type of record for one or more items. Requires a valid query string.
See https://rally1.rallydev.com/slm/doc/webservice/introduction.jsp for
information on query syntax.
CLI Example:
.. code-block:: bash
salt myminion rally... |
Show an item | def show_item(name, id_):
'''
Show an item
CLI Example:
.. code-block:: bash
salt myminion rallydev.show_<item name> <item id>
'''
status, result = _query(action=name, command=id_)
return result |
Update an item. Either a field and a value or a chunk of POST data may be used but not both. | def update_item(name, id_, field=None, value=None, postdata=None):
'''
Update an item. Either a field and a value, or a chunk of POST data, may be
used, but not both.
CLI Example:
.. code-block:: bash
salt myminion rallydev.update_<item name> <item id> field=<field> value=<value>
... |
If s is an instance of binary_type return s. decode ( encoding errors ) otherwise return s | def text_(s, encoding='latin-1', errors='strict'):
'''
If ``s`` is an instance of ``binary_type``, return
``s.decode(encoding, errors)``, otherwise return ``s``
'''
return s.decode(encoding, errors) if isinstance(s, binary_type) else s |
Python 3: If s is an instance of text_type return s. encode ( ascii ) otherwise return str ( s ascii strict ) | def ascii_native_(s):
'''
Python 3: If ``s`` is an instance of ``text_type``, return
``s.encode('ascii')``, otherwise return ``str(s, 'ascii', 'strict')``
Python 2: If ``s`` is an instance of ``text_type``, return
``s.encode('ascii')``, otherwise return ``str(s)``
'''
if isinstance(s, text_... |
Python 3: If s is an instance of text_type return s otherwise return str ( s encoding errors ) | def native_(s, encoding='latin-1', errors='strict'):
'''
Python 3: If ``s`` is an instance of ``text_type``, return ``s``, otherwise
return ``str(s, encoding, errors)``
Python 2: If ``s`` is an instance of ``text_type``, return
``s.encode(encoding, errors)``, otherwise return ``str(s)``
'''
... |
Check if data is hexadecimal packed | def _is_packed_binary(self, data):
'''
Check if data is hexadecimal packed
:param data:
:return:
'''
packed = False
if isinstance(data, bytes) and len(data) == 16 and b':' not in data:
try:
packed = bool(int(binascii.hexlify(data), 16)... |
Combine the host header IP address and TCP port into bindingInformation format. Binding Information specifies information to communicate with a site. It includes the IP address the port number and an optional host header ( usually a host name ) to communicate with the site. | def _get_binding_info(host_header='', ip_address='*', port=80):
'''
Combine the host header, IP address, and TCP port into bindingInformation
format. Binding Information specifies information to communicate with a
site. It includes the IP address, the port number, and an optional host
header (usuall... |
List details of available certificates in the LocalMachine certificate store. | def _list_certs(certificate_store='My'):
'''
List details of available certificates in the LocalMachine certificate
store.
Args:
certificate_store (str): The name of the certificate store on the local
machine.
Returns:
dict: A dictionary of certificates found in the sto... |
Execute a powershell command from the WebAdministration PS module. | def _srvmgr(cmd, return_json=False):
'''
Execute a powershell command from the WebAdministration PS module.
Args:
cmd (list): The command to execute in a list
return_json (bool): True formats the return in JSON, False just returns
the output of the command.
Returns:
... |
Returns index of collection item matching the match dictionary. | def _collection_match_to_index(pspath, colfilter, name, match):
'''
Returns index of collection item matching the match dictionary.
'''
collection = get_webconfiguration_settings(pspath, [{'name': name, 'filter': colfilter}])[0]['value']
for idx, collect_dict in enumerate(collection):
if all... |
Prepare settings before execution with get or set functions. Removes settings with a match parameter when index is not found. | def _prepare_settings(pspath, settings):
'''
Prepare settings before execution with get or set functions.
Removes settings with a match parameter when index is not found.
'''
prepared_settings = []
for setting in settings:
match = re.search(r'Collection\[(\{.*\})\]', setting['name'])
... |
List all the currently deployed websites. | def list_sites():
'''
List all the currently deployed websites.
Returns:
dict: A dictionary of the IIS sites and their properties.
CLI Example:
.. code-block:: bash
salt '*' win_iis.list_sites
'''
ret = dict()
ps_cmd = ['Get-ChildItem',
'-Path', r"'IIS:\... |
Create a basic website in IIS. | def create_site(name, sourcepath, apppool='', hostheader='',
ipaddress='*', port=80, protocol='http', preload=''):
'''
Create a basic website in IIS.
.. note::
This function only validates against the site name, and will return True
even if the site already exists with a di... |
Modify a basic website in IIS. | def modify_site(name, sourcepath=None, apppool=None, preload=None):
'''
Modify a basic website in IIS.
.. versionadded:: 2017.7.0
Args:
name (str): The IIS site name.
sourcepath (str): The physical path of the IIS site.
apppool (str): The name of the IIS application pool.
... |
Delete a website from IIS. | def remove_site(name):
'''
Delete a website from IIS.
Args:
name (str): The IIS site name.
Returns:
bool: True if successful, otherwise False
.. note::
This will not remove the application pool used by the site.
CLI Example:
.. code-block:: bash
salt '*... |
Stop a Web Site in IIS. | def stop_site(name):
'''
Stop a Web Site in IIS.
.. versionadded:: 2017.7.0
Args:
name (str): The name of the website to stop.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.stop_site name='My Test Site'
... |
Start a Web Site in IIS. | def start_site(name):
'''
Start a Web Site in IIS.
.. versionadded:: 2017.7.0
Args:
name (str): The name of the website to start.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.start_site name='My Test Site'... |
Get all configured IIS bindings for the specified site. | def list_bindings(site):
'''
Get all configured IIS bindings for the specified site.
Args:
site (str): The name if the IIS Site
Returns:
dict: A dictionary of the binding names and properties.
CLI Example:
.. code-block:: bash
salt '*' win_iis.list_bindings site
... |
Create an IIS Web Binding. | def create_binding(site, hostheader='', ipaddress='*', port=80, protocol='http',
sslflags=None):
'''
Create an IIS Web Binding.
.. note::
This function only validates against the binding
ipaddress:port:hostheader combination, and will return True even if the
bind... |
Modify an IIS Web Binding. Use site and binding to target the binding. | def modify_binding(site, binding, hostheader=None, ipaddress=None, port=None,
sslflags=None):
'''
Modify an IIS Web Binding. Use ``site`` and ``binding`` to target the
binding.
.. versionadded:: 2017.7.0
Args:
site (str): The IIS site name.
binding (str): The bin... |
Remove an IIS binding. | def remove_binding(site, hostheader='', ipaddress='*', port=80):
'''
Remove an IIS binding.
Args:
site (str): The IIS site name.
hostheader (str): The host header of the binding.
ipaddress (str): The IP address of the binding.
port (int): The TCP port of the binding.
Re... |
List certificate bindings for an IIS site. | def list_cert_bindings(site):
'''
List certificate bindings for an IIS site.
.. versionadded:: 2016.11.0
Args:
site (str): The IIS site name.
Returns:
dict: A dictionary of the binding names and properties.
CLI Example:
.. code-block:: bash
salt '*' win_iis.list... |
Assign a certificate to an IIS Web Binding. | def create_cert_binding(name, site, hostheader='', ipaddress='*', port=443,
sslflags=0):
'''
Assign a certificate to an IIS Web Binding.
.. versionadded:: 2016.11.0
.. note::
The web binding that the certificate is being assigned to must already
exist.
Arg... |
Remove a certificate from an IIS Web Binding. | def remove_cert_binding(name, site, hostheader='', ipaddress='*', port=443):
'''
Remove a certificate from an IIS Web Binding.
.. versionadded:: 2016.11.0
.. note::
This function only removes the certificate from the web binding. It does
not remove the web binding itself.
Args:
... |
List all configured IIS application pools. | def list_apppools():
'''
List all configured IIS application pools.
Returns:
dict: A dictionary of IIS application pools and their details.
CLI Example:
.. code-block:: bash
salt '*' win_iis.list_apppools
'''
ret = dict()
ps_cmd = []
ps_cmd.append(r"Get-ChildItem ... |
Create an IIS application pool. | def create_apppool(name):
'''
Create an IIS application pool.
.. note::
This function only validates against the application pool name, and will
return True even if the application pool already exists with a different
configuration. It will not modify the configuration of an existi... |
Stop an IIS application pool. | def stop_apppool(name):
'''
Stop an IIS application pool.
.. versionadded:: 2017.7.0
Args:
name (str): The name of the App Pool to stop.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.stop_apppool name='MyTe... |
Start an IIS application pool. | def start_apppool(name):
'''
Start an IIS application pool.
.. versionadded:: 2017.7.0
Args:
name (str): The name of the App Pool to start.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.start_apppool name='... |
Restart an IIS application pool. | def restart_apppool(name):
'''
Restart an IIS application pool.
.. versionadded:: 2016.11.0
Args:
name (str): The name of the IIS application pool.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.restart_appp... |
Get the value of the setting for the IIS container. | def get_container_setting(name, container, settings):
'''
Get the value of the setting for the IIS container.
.. versionadded:: 2016.11.0
Args:
name (str): The name of the IIS container.
container (str): The type of IIS container. The container types are:
AppPools, Sites, S... |
Set the value of the setting for an IIS container. | def set_container_setting(name, container, settings):
'''
Set the value of the setting for an IIS container.
.. versionadded:: 2016.11.0
Args:
name (str): The name of the IIS container.
container (str): The type of IIS container. The container types are:
AppPools, Sites, Ss... |
Get all configured IIS applications for the specified site. | def list_apps(site):
'''
Get all configured IIS applications for the specified site.
Args:
site (str): The IIS site name.
Returns: A dictionary of the application names and properties.
CLI Example:
.. code-block:: bash
salt '*' win_iis.list_apps site
'''
ret = dict()... |
Create an IIS application. | def create_app(name, site, sourcepath, apppool=None):
'''
Create an IIS application.
.. note::
This function only validates against the application name, and will
return True even if the application already exists with a different
configuration. It will not modify the configuration... |
Remove an IIS application. | def remove_app(name, site):
'''
Remove an IIS application.
Args:
name (str): The application name.
site (str): The IIS site name.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.remove_app name='app0' site... |
Get all configured IIS virtual directories for the specified site or for the combination of site and application. | def list_vdirs(site, app=_DEFAULT_APP):
'''
Get all configured IIS virtual directories for the specified site, or for
the combination of site and application.
Args:
site (str): The IIS site name.
app (str): The IIS application.
Returns:
dict: A dictionary of the virtual dir... |
Create an IIS virtual directory. | def create_vdir(name, site, sourcepath, app=_DEFAULT_APP):
'''
Create an IIS virtual directory.
.. note::
This function only validates against the virtual directory name, and
will return True even if the virtual directory already exists with a
different configuration. It will not m... |
Remove an IIS virtual directory. | def remove_vdir(name, site, app=_DEFAULT_APP):
'''
Remove an IIS virtual directory.
Args:
name (str): The virtual directory name.
site (str): The IIS site name.
app (str): The IIS application.
Returns:
bool: True if successful, otherwise False
CLI Example:
.. ... |
r Backup an IIS Configuration on the System. | def create_backup(name):
r'''
Backup an IIS Configuration on the System.
.. versionadded:: 2017.7.0
.. note::
Backups are stored in the ``$env:Windir\System32\inetsrv\backup``
folder.
Args:
name (str): The name to give the backup
Returns:
bool: True if success... |
Remove an IIS Configuration backup from the System. | def remove_backup(name):
'''
Remove an IIS Configuration backup from the System.
.. versionadded:: 2017.7.0
Args:
name (str): The name of the backup to remove
Returns:
bool: True if successful, otherwise False
CLI Example:
.. code-block:: bash
salt '*' win_iis.r... |
Returns a list of worker processes that correspond to the passed application pool. | def list_worker_processes(apppool):
'''
Returns a list of worker processes that correspond to the passed
application pool.
.. versionadded:: 2017.7.0
Args:
apppool (str): The application pool to query
Returns:
dict: A dictionary of worker processes with their process IDs
... |
r.. versionadded:: 2017. 7. 0 | def get_webapp_settings(name, site, settings):
r'''
.. versionadded:: 2017.7.0
Get the value of the setting for the IIS web application.
.. note::
Params are case sensitive
:param str name: The name of the IIS web application.
:param str site: The site name contains the web applicatio... |
r.. versionadded:: 2017. 7. 0 | def set_webapp_settings(name, site, settings):
r'''
.. versionadded:: 2017.7.0
Configure an IIS application.
.. note::
This function only configures an existing app. Params are case
sensitive.
:param str name: The IIS application.
:param str site: The IIS site name.
:param... |
r Get the webconfiguration settings for the IIS PSPath. | def get_webconfiguration_settings(name, settings, location=''):
r'''
Get the webconfiguration settings for the IIS PSPath.
Args:
name (str): The PSPath of the IIS webconfiguration settings.
settings (list): A list of dictionaries containing setting name and filter.
location (str): T... |
r Set the value of the setting for an IIS container. | def set_webconfiguration_settings(name, settings, location=''):
r'''
Set the value of the setting for an IIS container.
Args:
name (str): The PSPath of the IIS webconfiguration settings.
settings (list): A list of dictionaries containing setting name, filter and value.
location (str... |
Create a DNS record. The nameserver must be an IP address and the master running this runner must have create privileges on that server. | def create(zone, name, ttl, rdtype, data, keyname, keyfile, nameserver,
timeout, port=53, keyalgorithm='hmac-md5'):
'''
Create a DNS record. The nameserver must be an IP address and the master running
this runner must have create privileges on that server.
CLI Example:
.. code-block:: b... |
Create both A and PTR ( reverse ) records for a host. | def add_host(zone, name, ttl, ip, keyname, keyfile, nameserver, timeout,
port=53, keyalgorithm='hmac-md5'):
'''
Create both A and PTR (reverse) records for a host.
CLI Example:
.. code-block:: bash
salt-run ddns.add_host domain.com my-test-vm 3600 10.20.30.40 my-tsig-key /etc/sal... |
Delete both forward ( A ) and reverse ( PTR ) records for a host only if the forward ( A ) record exists. | def delete_host(zone, name, keyname, keyfile, nameserver, timeout, port=53,
keyalgorithm='hmac-md5'):
'''
Delete both forward (A) and reverse (PTR) records for a host only if the
forward (A) record exists.
CLI Example:
.. code-block:: bash
salt-run ddns.delete_host domain.... |
Given a list of comments or a comment submitted as a string return a single line of text containing all of the comments. | def combine_comments(comments):
'''
Given a list of comments, or a comment submitted as a string, return a
single line of text containing all of the comments.
'''
if isinstance(comments, list):
for idx in range(len(comments)):
if not isinstance(comments[idx], six.string_types):
... |
Remove the trailing slash from the URI in a repo definition | def strip_uri(repo):
'''
Remove the trailing slash from the URI in a repo definition
'''
splits = repo.split()
for idx in range(len(splits)):
if any(splits[idx].startswith(x)
for x in ('http://', 'https://', 'ftp://')):
splits[idx] = splits[idx].rstrip('/')
ret... |
Authenticate with vCenter server and return service instance object. | def _get_si():
'''
Authenticate with vCenter server and return service instance object.
'''
url = config.get_cloud_config_value(
'url', get_configured_provider(), __opts__, search_global=False
)
username = config.get_cloud_config_value(
'user', get_configured_provider(), __opts_... |
Helper function for adding new IDE controllers | def _add_new_ide_controller_helper(ide_controller_label,
controller_key,
bus_number):
'''
Helper function for adding new IDE controllers
.. versionadded:: 2016.3.0
Args:
ide_controller_label: label of the IDE controller
... |
Check if the IP address is valid and routable Return either True or False | def _valid_ip(ip_address):
'''
Check if the IP address is valid and routable
Return either True or False
'''
try:
address = ipaddress.IPv4Address(ip_address)
except ipaddress.AddressValueError:
return False
if address.is_unspecified or \
address.is_loopback or \
... |
Check if the IPv6 address is valid and routable Return either True or False | def _valid_ip6(ip_address):
'''
Check if the IPv6 address is valid and routable
Return either True or False
'''
# Validate IPv6 address
try:
address = ipaddress.IPv6Address(ip_address)
except ipaddress.AddressValueError:
return False
if address.is_unspecified or \
... |
Check if the salt master has a valid and routable IPv6 address available | def _master_supports_ipv6():
'''
Check if the salt master has a valid and
routable IPv6 address available
'''
master_fqdn = salt.utils.network.get_fqhostname()
pillar_util = salt.utils.master.MasterPillarUtil(master_fqdn,
tgt_type='glob',
... |
Convert a string representation of a HostHostBusAdapter into an object reference. | def _get_hba_type(hba_type):
'''
Convert a string representation of a HostHostBusAdapter into an
object reference.
'''
if hba_type == "parallel":
return vim.host.ParallelScsiHba
elif hba_type == "block":
return vim.host.BlockHba
elif hba_type == "iscsi":
return vim.ho... |
Show the vCenter Server version with build number. | def get_vcenter_version(kwargs=None, call=None):
'''
Show the vCenter Server version with build number.
CLI Example:
.. code-block:: bash
salt-cloud -f get_vcenter_version my-vmware-config
'''
if call != 'function':
raise SaltCloudSystemExit(
'The get_vcenter_versi... |
List all the data centers for this VMware environment | def list_datacenters(kwargs=None, call=None):
'''
List all the data centers for this VMware environment
CLI Example:
.. code-block:: bash
salt-cloud -f list_datacenters my-vmware-config
'''
if call != 'function':
raise SaltCloudSystemExit(
'The list_datacenters fun... |
List all the distributed virtual portgroups for this VMware environment | def list_portgroups(kwargs=None, call=None):
'''
List all the distributed virtual portgroups for this VMware environment
CLI Example:
.. code-block:: bash
salt-cloud -f list_portgroups my-vmware-config
'''
if call != 'function':
raise SaltCloudSystemExit(
'The list... |
List all the clusters for this VMware environment | def list_clusters(kwargs=None, call=None):
'''
List all the clusters for this VMware environment
CLI Example:
.. code-block:: bash
salt-cloud -f list_clusters my-vmware-config
'''
if call != 'function':
raise SaltCloudSystemExit(
'The list_clusters function must be... |
List all the datastore clusters for this VMware environment | def list_datastore_clusters(kwargs=None, call=None):
'''
List all the datastore clusters for this VMware environment
CLI Example:
.. code-block:: bash
salt-cloud -f list_datastore_clusters my-vmware-config
'''
if call != 'function':
raise SaltCloudSystemExit(
'The ... |
List all the datastores for this VMware environment | def list_datastores(kwargs=None, call=None):
'''
List all the datastores for this VMware environment
CLI Example:
.. code-block:: bash
salt-cloud -f list_datastores my-vmware-config
'''
if call != 'function':
raise SaltCloudSystemExit(
'The list_datastores function... |
List all the datastores for this VMware environment with extra information | def list_datastores_full(kwargs=None, call=None):
'''
List all the datastores for this VMware environment, with extra information
CLI Example:
.. code-block:: bash
salt-cloud -f list_datastores_full my-vmware-config
'''
if call != 'function':
raise SaltCloudSystemExit(
... |
Returns a dictionary with basic information for the given datastore | def list_datastore_full(kwargs=None, call=None, datastore=None):
'''
Returns a dictionary with basic information for the given datastore
CLI Example:
.. code-block:: bash
salt-cloud -f list_datastore_full my-vmware-config datastore=datastore-name
'''
if call != 'function':
rai... |
List all the hosts for this VMware environment | def list_hosts(kwargs=None, call=None):
'''
List all the hosts for this VMware environment
CLI Example:
.. code-block:: bash
salt-cloud -f list_hosts my-vmware-config
'''
if call != 'function':
raise SaltCloudSystemExit(
'The list_hosts function must be called with... |
List all the resource pools for this VMware environment | def list_resourcepools(kwargs=None, call=None):
'''
List all the resource pools for this VMware environment
CLI Example:
.. code-block:: bash
salt-cloud -f list_resourcepools my-vmware-config
'''
if call != 'function':
raise SaltCloudSystemExit(
'The list_resourcep... |
List all the standard networks for this VMware environment | def list_networks(kwargs=None, call=None):
'''
List all the standard networks for this VMware environment
CLI Example:
.. code-block:: bash
salt-cloud -f list_networks my-vmware-config
'''
if call != 'function':
raise SaltCloudSystemExit(
'The list_networks functio... |
Return a list of all VMs and templates that are on the specified provider with no details | def list_nodes_min(kwargs=None, call=None):
'''
Return a list of all VMs and templates that are on the specified provider, with no details
CLI Example:
.. code-block:: bash
salt-cloud -f list_nodes_min my-vmware-config
'''
if call == 'action':
raise SaltCloudSystemExit(
... |
Return a list of all VMs and templates that are on the specified provider with basic fields | def list_nodes(kwargs=None, call=None):
'''
Return a list of all VMs and templates that are on the specified provider, with basic fields
CLI Example:
.. code-block:: bash
salt-cloud -f list_nodes my-vmware-config
To return a list of all VMs and templates present on ALL configured provide... |
Return a list of all VMs and templates that are on the specified provider with fields specified under query. selection in/ etc/ salt/ cloud | def list_nodes_select(call=None):
'''
Return a list of all VMs and templates that are on the specified provider, with fields
specified under ``query.selection`` in ``/etc/salt/cloud``
CLI Example:
.. code-block:: bash
salt-cloud -f list_nodes_select my-vmware-config
To return a list ... |
List all available details of the specified VM | def show_instance(name, call=None):
'''
List all available details of the specified VM
CLI Example:
.. code-block:: bash
salt-cloud -a show_instance vmname
'''
if call != 'action':
raise SaltCloudSystemExit(
'The show_instance action must be called with '
... |
Return a list of all the templates present in this VMware environment with basic details | def avail_images(call=None):
'''
Return a list of all the templates present in this VMware environment with basic
details
CLI Example:
.. code-block:: bash
salt-cloud --list-images my-vmware-config
'''
if call == 'action':
raise SaltCloudSystemExit(
'The avail_... |
List all the folders for this VMware environment | def list_folders(kwargs=None, call=None):
'''
List all the folders for this VMware environment
CLI Example:
.. code-block:: bash
salt-cloud -f list_folders my-vmware-config
'''
if call != 'function':
raise SaltCloudSystemExit(
'The list_folders function must be cal... |
List snapshots either for all VMs and templates or for a specific VM/ template in this VMware environment | def list_snapshots(kwargs=None, call=None):
'''
List snapshots either for all VMs and templates or for a specific VM/template
in this VMware environment
To list snapshots for all VMs and templates:
CLI Example:
.. code-block:: bash
salt-cloud -f list_snapshots my-vmware-config
T... |
To suspend a VM using its name | def suspend(name, call=None):
'''
To suspend a VM using its name
CLI Example:
.. code-block:: bash
salt-cloud -a suspend vmname
'''
if call != 'action':
raise SaltCloudSystemExit(
'The suspend action must be called with '
'-a or --action.'
)
... |
To reset a VM using its name | def reset(name, soft=False, call=None):
'''
To reset a VM using its name
.. note::
If ``soft=True`` then issues a command to the guest operating system
asking it to perform a reboot. Otherwise hypervisor will terminate VM and start it again.
Default is soft=False
For ``sof... |
To do an immediate power off of a VM using its name. A SIGKILL is issued to the vmx process of the VM | def terminate(name, call=None):
'''
To do an immediate power off of a VM using its name. A ``SIGKILL``
is issued to the vmx process of the VM
CLI Example:
.. code-block:: bash
salt-cloud -a terminate vmname
'''
if call != 'action':
raise SaltCloudSystemExit(
'T... |
To destroy a VM from the VMware environment | def destroy(name, call=None):
'''
To destroy a VM from the VMware environment
CLI Example:
.. code-block:: bash
salt-cloud -d vmname
salt-cloud --destroy vmname
salt-cloud -a destroy vmname
'''
if call == 'function':
raise SaltCloudSystemExit(
'The ... |
To create a single VM in the VMware environment. | def create(vm_):
'''
To create a single VM in the VMware environment.
Sample profile and arguments that can be specified in it can be found
:ref:`here. <vmware-cloud-profile>`
CLI Example:
.. code-block:: bash
salt-cloud -p vmware-centos6.5 vmname
'''
try:
# Check for... |
Returns a clone spec for cloning from shapshots: rtype vim. vm. CloneSpec | def handle_snapshot(config_spec, object_ref, reloc_spec, template, vm_):
'''
Returns a clone spec for cloning from shapshots
:rtype vim.vm.CloneSpec
'''
if 'snapshot' not in vm_:
return None
allowed_types = [
FLATTEN_DISK_FULL_CLONE,
COPY_ALL_DISKS_FULL_CLONE,
CU... |
return clonespec only if values are valid | def get_clonespec_for_valid_snapshot(config_spec, object_ref, reloc_spec, template, vm_):
'''
return clonespec only if values are valid
'''
moving = True
if QUICK_LINKED_CLONE == vm_['snapshot']['disk_move_type']:
reloc_spec.diskMoveType = QUICK_LINKED_CLONE
elif CURRENT_STATE_LINKED_CLO... |
Returns the clone spec | def build_clonespec(config_spec, object_ref, reloc_spec, template):
'''
Returns the clone spec
'''
if reloc_spec.diskMoveType == QUICK_LINKED_CLONE:
return vim.vm.CloneSpec(
template=template,
location=reloc_spec,
config=config_spec,
snapshot=objec... |
Create a new data center in this VMware environment | def create_datacenter(kwargs=None, call=None):
'''
Create a new data center in this VMware environment
CLI Example:
.. code-block:: bash
salt-cloud -f create_datacenter my-vmware-config name="MyNewDatacenter"
'''
if call != 'function':
raise SaltCloudSystemExit(
'T... |
Create a new cluster under the specified datacenter in this VMware environment | def create_cluster(kwargs=None, call=None):
'''
Create a new cluster under the specified datacenter in this VMware environment
CLI Example:
.. code-block:: bash
salt-cloud -f create_cluster my-vmware-config name="myNewCluster" datacenter="datacenterName"
'''
if call != 'function':
... |
To rescan a specified HBA or all the HBAs on the Host System | def rescan_hba(kwargs=None, call=None):
'''
To rescan a specified HBA or all the HBAs on the Host System
CLI Example:
.. code-block:: bash
salt-cloud -f rescan_hba my-vmware-config host="hostSystemName"
salt-cloud -f rescan_hba my-vmware-config hba="hbaDeviceName" host="hostSystemName... |
To upgrade VMware Tools on all virtual machines present in the specified provider | def upgrade_tools_all(call=None):
'''
To upgrade VMware Tools on all virtual machines present in
the specified provider
.. note::
If the virtual machine is running Windows OS, this function
will attempt to suppress the automatic reboot caused by a
VMware Tools upgrade.
CLI... |
To upgrade VMware Tools on a specified virtual machine. | def upgrade_tools(name, reboot=False, call=None):
'''
To upgrade VMware Tools on a specified virtual machine.
.. note::
If the virtual machine is running Windows OS, use ``reboot=True``
to reboot the virtual machine after VMware tools upgrade. Default
is ``reboot=False``
CLI E... |
List hosts for each cluster ; or hosts for a specified cluster in this VMware environment | def list_hosts_by_cluster(kwargs=None, call=None):
'''
List hosts for each cluster; or hosts for a specified cluster in
this VMware environment
To list hosts for each cluster:
CLI Example:
.. code-block:: bash
salt-cloud -f list_hosts_by_cluster my-vmware-config
To list hosts fo... |
List clusters for each datacenter ; or clusters for a specified datacenter in this VMware environment | def list_clusters_by_datacenter(kwargs=None, call=None):
'''
List clusters for each datacenter; or clusters for a specified datacenter in
this VMware environment
To list clusters for each datacenter:
CLI Example:
.. code-block:: bash
salt-cloud -f list_clusters_by_datacenter my-vmwar... |
List all HBAs for each host system ; or all HBAs for a specified host system ; or HBAs of specified type for each host system ; or HBAs of specified type for a specified host system in this VMware environment | def list_hbas(kwargs=None, call=None):
'''
List all HBAs for each host system; or all HBAs for a specified host
system; or HBAs of specified type for each host system; or HBAs of
specified type for a specified host system in this VMware environment
.. note::
You can specify type as either ... |
List all the distributed virtual switches for this VMware environment | def list_dvs(kwargs=None, call=None):
'''
List all the distributed virtual switches for this VMware environment
CLI Example:
.. code-block:: bash
salt-cloud -f list_dvs my-vmware-config
'''
if call != 'function':
raise SaltCloudSystemExit(
'The list_dvs function mu... |
List all the vApps for this VMware environment | def list_vapps(kwargs=None, call=None):
'''
List all the vApps for this VMware environment
CLI Example:
.. code-block:: bash
salt-cloud -f list_vapps my-vmware-config
'''
if call != 'function':
raise SaltCloudSystemExit(
'The list_vapps function must be called with... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.