neulab/tldr huggingface dataset:
salt.modules.pagerduty.list_users(profile=None, api_key=None) List users belonging to this account
salt myminion pagerduty.list_users my-pagerduty-account
salt.modules.pagerduty.list_windows(profile=None, api_key=None) List maintenance windows belonging to this account
salt.modules.pagerduty_util Module for manageing PagerDuty resource
configuration This module can be used by specifying the name of a configuration profile in the minion config, minion pillar, or master config. The default configuration profile name is 'pagerduty.'
pagerduty: pagerduty.api_key: F3Rbyjbve43rfFWf2214 pagerduty.subdomain: mysubdomain
For PagerDuty API details, see https://developer.pagerduty.com/documentation/rest
salt.modules.pagerduty_util.create_or_update_resource(resource_name, identifier_fields, data, diff=None, profile='pagerduty', subdomain=None, api_key=None) create or update any pagerduty resource Helper method for present().
Determining if two resources are the same is different for different PD resource, so this method accepts a diff function. The diff function will be invoked as diff(state_information, object_returned_from_pagerduty), and should return a dict of data to pass to the PagerDuty update API method, or None if no update is to be performed.  If no diff method is provided, the default behavor is to scan the keys in the state_information, comparing the matching values in the object_returned_from_pagerduty, and update any values that differ.
create_or_update_resource("user", ["id","name","email"]) create_or_update_resource("escalation_policies", ["id","name"], diff=my_diff_function)
salt.modules.pagerduty_util.delete_resource(resource_name, key, identifier_fields, profile='pagerduty', subdomain=None, api_key=None) delete any pagerduty resource
Helper method for absent()
delete_resource("users", key, ["id","name","email"]) # delete by id or name or email
salt.modules.pagerduty_util.get_escalation_policies(profile='pagerduty', subdomain=None, api_key=None) List escalation_policies belonging to this account
salt myminion pagerduty.get_escalation_policies
salt.modules.pagerduty_util.get_resource(resource_name, key, identifier_fields, profile='pagerduty', subdomain=None, api_key=None) Get any single pagerduty resource by key.
We allow flexible lookup by any of a list of identifier_fields. So, for example, you can look up users by email address or name by calling: get_resource('users', key, ['name', 'email'], ...)
This method is mainly used to translate state sls into pagerduty id's for dependent objects.  For example, a pagerduty escalation policy contains one or more schedules, which must be passed by their pagerduty id.  We look up the schedules by name (using this method), and then translate the names into id's.
This method is implemented by getting all objects of the resource type (cached into __context__), then brute force searching through the list and trying to match any of the identifier_fields.  The __context__ cache is purged after any create, update or delete to the resource.
salt.modules.pagerduty_util.get_schedules(profile='pagerduty', subdomain=None, api_key=None) List schedules belonging to this account
salt myminion pagerduty.get_schedules
salt.modules.pagerduty_util.get_services(profile='pagerduty', subdomain=None, api_key=None) List services belonging to this account
salt myminion pagerduty.get_services
salt.modules.pagerduty_util.get_users(profile='pagerduty', subdomain=None, api_key=None) List users belonging to this account
salt myminion pagerduty.get_users
salt.modules.pagerduty_util.resource_absent(resource, identifier_fields, profile='pagerduty', subdomain=None, api_key=None, **kwargs) Generic resource.absent state method.   Pagerduty state modules should be a thin wrapper over this method, with a custom diff function.
This method calls delete_resource() and formats the result as a salt state return value.
resource_absent("users", ["id","name","email"])
salt.modules.pagerduty_util.resource_present(resource, identifier_fields, diff=None, profile='pagerduty', subdomain=None, api_key=None, **kwargs) Generic resource.present state method.   Pagerduty state modules should be a thin wrapper over this method, with a custom diff function.
This method calls create_or_update_resource() and formats the result as a salt state return value.
resource_present("users", ["id","name","email"])
salt.modules.pam Support for pam
salt.modules.pam.read_file(file_name) This is just a test function, to make sure parsing works
salt '*' pam.read_file /etc/pam.d/login
salt.modules.panos Module to provide Palo Alto compatibility to Salt
SEE ALSO: Palo Alto Proxy Module
About This execution module was designed to handle connections to a Palo Alto based firewall. This module adds support to send connections directly to the device through the XML API or through a brokered connection to Panorama.
salt.modules.panos.add_config_lock() Prevent other users from changing configuration until the lock is released.
salt '*' panos.add_config_lock
salt.modules.panos.check_antivirus() Get anti-virus information from PaloAlto Networks server
salt '*' panos.check_antivirus
salt.modules.panos.check_software() Get software information from PaloAlto Networks server.
salt '*' panos.check_software
salt.modules.panos.clear_commit_tasks() Clear all commit tasks.
salt '*' panos.clear_commit_tasks
salt.modules.panos.commit() Commits the candidate configuration to the running configuration.
salt '*' panos.commit
salt.modules.panos.deactivate_license(key_name=None) Deactivates an installed license.  Required version 7.0.0 or greater.
key_name(str): The file name of the license key installed.
salt '*' panos.deactivate_license key_name=License_File_Name.key
salt.modules.panos.delete_license(key_name=None) Remove license keys on disk.
key_name(str): The file name of the license key to be deleted.
salt '*' panos.delete_license key_name=License_File_Name.key
salt.modules.panos.download_antivirus() Download the most recent anti-virus package.
salt '*' panos.download_antivirus
salt.modules.panos.download_software_file(filename=None, synch=False) Download software packages by filename.
• filename (str) -- The filename of the PANOS file to download.
• synch (bool) -- If true then the file will synch to the peer unit.
salt '*' panos.download_software_file PanOS_5000-8.0.0 salt '*' panos.download_software_file PanOS_5000-8.0.0 True
salt.modules.panos.download_software_version(version=None, synch=False) Download software packages by version number.
• version (str) -- The version of the PANOS file to download.
salt '*' panos.download_software_version 8.0.0 salt '*' panos.download_software_version 8.0.0 True
salt.modules.panos.fetch_license(auth_code=None) Get new license(s) using from the Palo Alto Network Server.
auth_code The license authorization code.
salt '*' panos.fetch_license salt '*' panos.fetch_license auth_code=foobar
salt.modules.panos.get_address(address=None, vsys='1') Get the candidate configuration for the specified get_address object. This will not return address objects that are marked as pre-defined objects.
address(str): The name of the address object.
vsys(str): The string representation of the VSYS ID.
salt '*' panos.get_address myhost salt '*' panos.get_address myhost 3
salt.modules.panos.get_address_group(addressgroup=None, vsys='1') Get the candidate configuration for the specified address group. This will not return address groups that are marked as pre-defined objects.
addressgroup(str): The name of the address group.
salt '*' panos.get_address_group foobar salt '*' panos.get_address_group foobar 3
salt.modules.panos.get_admins_active() Show active administrators.
salt '*' panos.get_admins_active
salt.modules.panos.get_admins_all() Show all administrators.
salt '*' panos.get_admins_all
salt.modules.panos.get_antivirus_info() Show information about available anti-virus packages.
salt '*' panos.get_antivirus_info
salt.modules.panos.get_arp() Show ARP information.
salt '*' panos.get_arp
salt.modules.panos.get_cli_idle_timeout() Show timeout information for this administrative session.
salt '*' panos.get_cli_idle_timeout
salt.modules.panos.get_cli_permissions() Show cli administrative permissions.
salt '*' panos.get_cli_permissions
salt.modules.panos.get_disk_usage() Report filesystem disk space usage.
salt '*' panos.get_disk_usage
salt.modules.panos.get_dns_server_config() Get the DNS server configuration from the candidate configuration.
salt '*' panos.get_dns_server_config
salt.modules.panos.get_domain_config() Get the domain name configuration from the candidate configuration.
salt '*' panos.get_domain_config
salt.modules.panos.get_dos_blocks() Show the DoS block-ip table.
salt '*' panos.get_dos_blocks
salt.modules.panos.get_fqdn_cache() Print FQDNs used in rules and their IPs.
salt '*' panos.get_fqdn_cache
salt.modules.panos.get_ha_config() Get the high availability configuration.
salt '*' panos.get_ha_config
salt.modules.panos.get_ha_link() Show high-availability link-monitoring state.
salt '*' panos.get_ha_link
salt.modules.panos.get_ha_path() Show high-availability path-monitoring state.
salt '*' panos.get_ha_path
salt.modules.panos.get_ha_state() Show high-availability state information.
salt '*' panos.get_ha_state
salt.modules.panos.get_ha_transitions() Show high-availability transition statistic information.
salt '*' panos.get_ha_transitions
salt.modules.panos.get_hostname() Get the hostname of the device.
salt '*' panos.get_hostname
salt.modules.panos.get_interface_counters(name='all') Get the counter statistics for interfaces.
Parameters name (str) -- The name of the interface to view. By default, all interface statistics are viewed.
salt '*' panos.get_interface_counters salt '*' panos.get_interface_counters ethernet1/1
salt.modules.panos.get_interfaces(name='all') Show interface information.
salt '*' panos.get_interfaces salt '*' panos.get_interfaces ethernet1/1
salt.modules.panos.get_job(jid=None) List all a single job by ID.
jid    The ID of the job to retrieve.
salt '*' panos.get_job jid=15
salt.modules.panos.get_jobs(state='all') List all jobs on the device.
state  The state of the jobs to display. Valid options are all, pending, or processed. Pending jobs are jobs that are currently in a running or waiting state. Processed jobs are jobs that have completed execution.
salt '*' panos.get_jobs salt '*' panos.get_jobs state=pending
salt.modules.panos.get_lacp() Show LACP state.
salt '*' panos.get_lacp
salt.modules.panos.get_license_info() Show information about owned license(s).
salt '*' panos.get_license_info
salt.modules.panos.get_license_tokens() Show license token files for manual license deactivation.
salt '*' panos.get_license_tokens
salt.modules.panos.get_lldp_config() Show lldp config for interfaces.
salt '*' panos.get_lldp_config
salt.modules.panos.get_lldp_counters() Show lldp counters for interfaces.
salt '*' panos.get_lldp_counters
salt.modules.panos.get_lldp_local() Show lldp local info for interfaces.
salt '*' panos.get_lldp_local
salt.modules.panos.get_lldp_neighbors() Show lldp neighbors info for interfaces.
salt '*' panos.get_lldp_neighbors
salt.modules.panos.get_local_admins() Show all local administrator accounts.
salt '*' panos.get_local_admins
salt.modules.panos.get_logdb_quota() Report the logdb quotas.
salt '*' panos.get_logdb_quota
salt.modules.panos.get_master_key() Get the master key properties.
salt '*' panos.get_master_key
salt.modules.panos.get_ntp_config() Get the NTP configuration from the candidate configuration.
salt '*' panos.get_ntp_config
salt.modules.panos.get_ntp_servers() Get list of configured NTP servers.
salt '*' panos.get_ntp_servers
salt.modules.panos.get_operational_mode() Show device operational mode setting.
salt '*' panos.get_operational_mode
salt.modules.panos.get_panorama_status() Show panorama connection status.
salt '*' panos.get_panorama_status
salt.modules.panos.get_permitted_ips() Get the IP addresses that are permitted to establish management connections to the device.
salt '*' panos.get_permitted_ips
salt.modules.panos.get_platform() Get the platform model information and limitations.
salt '*' panos.get_platform
salt.modules.panos.get_predefined_application(application=None) Get the configuration for the specified pre-defined application object. This will only return pre-defined application objects.
application(str): The name of the pre-defined application object.
salt '*' panos.get_predefined_application saltstack
salt.modules.panos.get_security_rule(rulename=None, vsys='1') Get the candidate configuration for the specified security rule.
rulename(str): The name of the security rule.
salt '*' panos.get_security_rule rule01 salt '*' panos.get_security_rule rule01 3
salt.modules.panos.get_service(service=None, vsys='1') Get the candidate configuration for the specified service object. This will not return services that are marked as pre-defined objects.
service(str): The name of the service object.
salt '*' panos.get_service tcp-443 salt '*' panos.get_service tcp-443 3
salt.modules.panos.get_service_group(servicegroup=None, vsys='1') Get the candidate configuration for the specified service group. This will not return service groups that are marked as pre-defined objects.
servicegroup(str): The name of the service group.
salt '*' panos.get_service_group foobar salt '*' panos.get_service_group foobar 3
salt.modules.panos.get_session_info() Show device session statistics.
salt '*' panos.get_session_info
salt.modules.panos.get_snmp_config() Get the SNMP configuration from the device.
salt '*' panos.get_snmp_config
salt.modules.panos.get_software_info() Show information about available software packages.
salt '*' panos.get_software_info
salt.modules.panos.get_system_date_time() Get the system date/time.
salt '*' panos.get_system_date_time
salt.modules.panos.get_system_files() List important files in the system.
salt '*' panos.get_system_files
salt.modules.panos.get_system_info() Get the system information.
salt '*' panos.get_system_info
salt.modules.panos.get_system_services() Show system services.
salt '*' panos.get_system_services
salt.modules.panos.get_system_state(mask=None) Show the system state variables.
mask   Filters by a subtree or a wildcard.
salt '*' panos.get_system_state salt '*' panos.get_system_state mask=cfg.ha.config.enabled salt '*' panos.get_system_state mask=cfg.ha.*
salt.modules.panos.get_uncommitted_changes() Retrieve a list of all uncommitted changes on the device. Requires PANOS version 8.0.0 or greater.
salt '*' panos.get_uncommitted_changes
salt.modules.panos.get_users_config() Get the local administrative user account configuration.
salt '*' panos.get_users_config
salt.modules.panos.get_vlans() Show all VLAN information.
salt '*' panos.get_vlans
salt.modules.panos.get_xpath(xpath='') Retrieve a specified xpath from the candidate configuration.
xpath(str): The specified xpath in the candidate configuration.
salt '*' panos.get_xpath /config/shared/service
salt.modules.panos.get_zone(zone='', vsys='1') Get the candidate configuration for the specified zone.
zone(str): The name of the zone.
salt '*' panos.get_zone trust salt '*' panos.get_zone trust 2
salt.modules.panos.get_zones(vsys='1') Get all the zones in the candidate configuration.
salt '*' panos.get_zones salt '*' panos.get_zones 2
salt.modules.panos.install_antivirus(version=None, latest=False, synch=False, skip_commit=False) Install anti-virus packages.
• version (str) -- The version of the PANOS file to install.
• latest (bool) -- If true, the latest anti-virus file will be installed.  The specified version option will be ignored.
• synch (bool) -- If true, the anti-virus will synch to the peer unit.
• skip_commit (bool) -- If true, the install will skip committing to the device.
salt '*' panos.install_antivirus 8.0.0
salt.modules.panos.install_license() Install the license key(s).
salt '*' panos.install_license
salt.modules.panos.install_software(version=None) Upgrade to a software package by version.
Parameters version (str) -- The version of the PANOS file to install.
salt '*' panos.install_license 8.0.0
salt.modules.panos.reboot() Reboot a running system.
salt '*' panos.reboot
salt.modules.panos.refresh_fqdn_cache(force=False) Force refreshes all FQDNs used in rules.
force  Forces all fqdn refresh
salt '*' panos.refresh_fqdn_cache salt '*' panos.refresh_fqdn_cache force=True
salt.modules.panos.remove_config_lock() Release config lock previously held.
salt '*' panos.remove_config_lock
salt.modules.panos.resolve_address(address=None, vsys=None) Resolve address to ip address.  Required version 7.0.0 or greater.
address Address name you want to resolve.
vsys   The vsys name.
salt '*' panos.resolve_address foo.bar.com salt '*' panos.resolve_address foo.bar.com vsys=2
salt.modules.panos.save_device_config(filename=None) Save device configuration to a named file.
filename The filename to save the configuration to.
salt '*' panos.save_device_config foo.xml
salt.modules.panos.save_device_state() Save files needed to restore device to local disk.
salt '*' panos.save_device_state
salt.modules.panos.set_authentication_profile(profile=None, deploy=False) Set the authentication profile of the Palo Alto proxy minion. A commit will be required before this is processed.
• profile (str) -- The name of the authentication profile to set.
• deploy (bool) -- If true then commit the full candidate configuration, if false only set pending change.
salt '*' panos.set_authentication_profile foo salt '*' panos.set_authentication_profile foo deploy=True
salt.modules.panos.set_hostname(hostname=None, deploy=False) Set the hostname of the Palo Alto proxy minion. A commit will be required before this is processed.
• hostname (str) -- The hostname to set
salt '*' panos.set_hostname newhostname salt '*' panos.set_hostname newhostname deploy=True
salt.modules.panos.set_management_http(enabled=True, deploy=False) Enables or disables the HTTP management service on the device.
• enabled (bool) -- If true the service will be enabled. If false the service will be disabled.
salt '*' panos.set_management_http salt '*' panos.set_management_http enabled=False deploy=True
salt.modules.panos.set_management_https(enabled=True, deploy=False) Enables or disables the HTTPS management service on the device.
salt '*' panos.set_management_https salt '*' panos.set_management_https enabled=False deploy=True
salt.modules.panos.set_management_icmp(enabled=True, deploy=False) Enables or disables the ICMP management service on the device.
salt '*' panos.set_management_icmp salt '*' panos.set_management_icmp enabled=False deploy=True
salt.modules.panos.set_management_ocsp(enabled=True, deploy=False) Enables or disables the HTTP OCSP management service on the device.
salt '*' panos.set_management_ocsp salt '*' panos.set_management_ocsp enabled=False deploy=True
salt.modules.panos.set_management_snmp(enabled=True, deploy=False) Enables or disables the SNMP management service on the device.
salt '*' panos.set_management_snmp salt '*' panos.set_management_snmp enabled=False deploy=True
salt.modules.panos.set_management_ssh(enabled=True, deploy=False) Enables or disables the SSH management service on the device.
salt '*' panos.set_management_ssh salt '*' panos.set_management_ssh enabled=False deploy=True
salt.modules.panos.set_management_telnet(enabled=True, deploy=False) Enables or disables the Telnet management service on the device.
salt '*' panos.set_management_telnet salt '*' panos.set_management_telnet enabled=False deploy=True
salt.modules.panos.set_ntp_authentication(target=None, authentication_type=None, key_id=None, authentication_key=None, algorithm=None, deploy=False) Set the NTP authentication of the Palo Alto proxy minion. A commit will be required before this is processed.
• target (str) -- Determines the target of the authentication. Valid options are primary, secondary, or both.
• authentication_type (str) -- The authentication type to be used. Valid options are symmetric, autokey, and none.
• key_id (int) -- The NTP authentication key ID.
• authentication_key (str) -- The authentication key.
• algorithm (str) -- The algorithm type to be used for a symmetric key. Valid options are md5 and sha1.
salt '*' ntp.set_authentication target=both authentication_type=autokey salt '*' ntp.set_authentication target=primary authentication_type=none salt '*' ntp.set_authentication target=both authentication_type=symmetric key_id=15 authentication_key=mykey algorithm=md5 salt '*' ntp.set_authentication target=both authentication_type=symmetric key_id=15 authentication_key=mykey algorithm=md5 deploy=True
salt.modules.panos.set_ntp_servers(primary_server=None, secondary_server=None, deploy=False) Set the NTP servers of the Palo Alto proxy minion. A commit will be required before this is processed.
• primary_server (str) -- The primary NTP server IP address or FQDN.
• secondary_server (str) -- The secondary NTP server IP address or FQDN.
salt '*' ntp.set_servers 0.pool.ntp.org 1.pool.ntp.org salt '*' ntp.set_servers primary_server=0.pool.ntp.org secondary_server=1.pool.ntp.org salt '*' ntp.ser_servers 0.pool.ntp.org 1.pool.ntp.org deploy=True
salt.modules.panos.set_permitted_ip(address=None, deploy=False) Add an IPv4 address or network to the permitted IP list.
• address (str) -- The IPv4 address or network to allow access to add to the Palo Alto device.
salt '*' panos.set_permitted_ip 10.0.0.1 salt '*' panos.set_permitted_ip 10.0.0.0/24 salt '*' panos.set_permitted_ip 10.0.0.1 deploy=True
salt.modules.panos.set_timezone(tz=None, deploy=False) Set the timezone of the Palo Alto proxy minion. A commit will be required before this is processed.
• tz (str) -- The name of the timezone to set.
salt '*' panos.set_timezone UTC salt '*' panos.set_timezone UTC deploy=True
salt.modules.panos.shutdown() Shutdown a running system.
salt '*' panos.shutdown
salt.modules.panos.test_fib_route(ip=None, vr='vr1') Perform a route lookup within active route table (fib).
ip (str): The destination IP address to test.
vr (str): The name of the virtual router to test.
salt '*' panos.test_fib_route 4.2.2.2 salt '*' panos.test_fib_route 4.2.2.2 my-vr
salt.modules.panos.test_security_policy(sourcezone=None, destinationzone=None, source=None, destination=None, protocol=None, port=None, application=None, category=None, vsys='1', allrules=False) Checks which security policy as connection will match on the device.
sourcezone (str): The source zone matched against the connection.
destinationzone (str): The destination zone matched against the connection.
source (str): The source address. This must be a single IP address.
destination (str): The destination address. This must be a single IP address.
protocol (int): The protocol number for the connection. This is the numerical representation of the protocol.
port (int): The port number for the connection.
application (str): The application that should be matched.
category (str): The category that should be matched.
vsys (int): The numerical representation of the VSYS ID.
allrules (bool): Show all potential match rules until first allow rule.
salt '*' panos.test_security_policy sourcezone=trust destinationzone=untrust protocol=6 port=22 salt '*' panos.test_security_policy sourcezone=trust destinationzone=untrust protocol=6 port=22 vsys=2
salt.modules.panos.unlock_admin(username=None) Unlocks a locked administrator account.
username Username of the administrator.
salt '*' panos.unlock_admin username=bob
salt.modules.parallels Manage Parallels Desktop VMs with prlctl and prlsrvctl.  Only some of the prlctl commands implemented so far.  Of those that have been implemented, not all of the options may have been provided yet.  For a complete reference, see the Parallels Desktop Reference Guide.
This module requires the prlctl binary to be installed to run most functions.  To run parallels.prlsrvctl, the prlsrvctl binary is required.
What has not been implemented yet can be accessed through parallels.prlctl and parallels.prlsrvctl (note the preceding double dash -- as necessary):
salt '*' parallels.prlctl installtools macvm runas=macdev salt -- '*' parallels.prlctl capture 'macvm --file macvm.display.png' runas=macdev salt -- '*' parallels.prlsrvctl set '--mem-limit auto' runas=macdev
salt.modules.parallels.clone(name, new_name, linked=False, template=False, runas=None) Clone a VM
• name (str) -- Name/ID of VM to clone
• new_name (str) -- Name of the new VM
• linked (bool) -- Create a linked virtual machine.
• template (bool) -- Create a virtual machine template instead of a real virtual machine.
• runas (str) -- The user that the prlctl command will be run as
salt '*' parallels.clone macvm macvm_new runas=macdev salt '*' parallels.clone macvm macvm_templ template=True runas=macdev
salt.modules.parallels.delete(name, runas=None) Delete a VM
salt '*' parallels.exec macvm 'find /etc/paths.d' runas=macdev
salt.modules.parallels.delete_snapshot(name, snap_name, runas=None, all=False) Delete a snapshot
NOTE: Deleting a snapshot from which other snapshots are dervied will not delete the derived snapshots
• name (str) -- Name/ID of VM whose snapshot will be deleted
• snap_name (str) -- Name/ID of snapshot to delete
• all (bool) --
Delete all snapshots having the name given
salt '*' parallels.delete_snapshot macvm 'unneeded snapshot' runas=macdev salt '*' parallels.delete_snapshot macvm 'Snapshot for linked clone' all=True runas=macdev
salt.modules.parallels.exec_(name, command, runas=None) Run a command on a VM
• name (str) -- Name/ID of VM whose exec will be returned
• command (str) -- Command to run on the VM
salt.modules.parallels.exists(name, runas=None) Query whether a VM exists
• name (str) -- Name/ID of VM
salt '*' parallels.exists macvm runas=macdev
salt.modules.parallels.list_snapshots(name, snap_name=None, tree=False, names=False, runas=None) List the snapshots
• name (str) -- Name/ID of VM whose snapshots will be listed
• snap_id (str) -- Name/ID of snapshot to display information about.  If tree=True is also specified, display the snapshot subtree having this snapshot as the root snapshot
• tree (bool) -- List snapshots in tree format rather than tabular format
• names (bool) -- List snapshots as ID, name pairs
salt '*' parallels.list_snapshots macvm runas=macdev salt '*' parallels.list_snapshots macvm tree=True runas=macdev salt '*' parallels.list_snapshots macvm snap_name=original runas=macdev salt '*' parallels.list_snapshots macvm names=True runas=macdev
salt.modules.parallels.list_vms(name=None, info=False, all=False, args=None, runas=None, template=False) List information about the VMs
• name (str) --
Name/ID of VM to list
Changed in version 2016.11.0: No longer implies info=True
• info (str) -- List extra information
• all (bool) -- List all non-template VMs
• args (tuple) -- Additional arguments given to prctl list
• template (bool) --
List the available virtual machine templates.  The real virtual machines will not be included in the output
salt '*' parallels.list_vms runas=macdev salt '*' parallels.list_vms name=macvm info=True runas=macdev salt '*' parallels.list_vms info=True runas=macdev salt '*' parallels.list_vms ' -o uuid,status' all=True runas=macdev
salt.modules.parallels.prlctl(sub_cmd, args=None, runas=None) Execute a prlctl command
• sub_cmd (str) -- prlctl subcommand to execute
• args (str) -- The arguments supplied to prlctl <sub_cmd>
salt '*' parallels.prlctl user list runas=macdev salt '*' parallels.prlctl exec 'macvm uname' runas=macdev salt -- '*' parallels.prlctl capture 'macvm --file macvm.display.png' runas=macdev
salt.modules.parallels.prlsrvctl(sub_cmd, args=None, runas=None) Execute a prlsrvctl command
• sub_cmd (str) -- prlsrvctl subcommand to execute
• args (str) -- The arguments supplied to prlsrvctl <sub_cmd>
• runas (str) -- The user that the prlsrvctl command will be run as
salt '*' parallels.prlsrvctl info runas=macdev salt '*' parallels.prlsrvctl usb list runas=macdev salt -- '*' parallels.prlsrvctl set '--mem-limit auto' runas=macdev
salt.modules.parallels.reset(name, runas=None) Reset a VM by performing a hard shutdown and then a restart
• name (str) -- Name/ID of VM to reset
salt '*' parallels.reset macvm runas=macdev
salt.modules.parallels.restart(name, runas=None) Restart a VM by gracefully shutting it down and then restarting it
• name (str) -- Name/ID of VM to restart
salt '*' parallels.restart macvm runas=macdev
salt.modules.parallels.revert_snapshot(name, snap_name, runas=None) Revert a VM to a snapshot
• name (str) -- Name/ID of VM to revert to a snapshot
• snap_name (str) -- Name/ID of snapshot to revert to
salt '*' parallels.revert_snapshot macvm base-with-updates runas=macdev
salt.modules.parallels.snapshot(name, snap_name=None, desc=None, runas=None) Create a snapshot
• name (str) -- Name/ID of VM to take a snapshot of
• snap_name (str) -- Name of snapshot
• desc (str) -- Description of snapshot
salt '*' parallels.create_snapshot macvm snap_name=macvm-original runas=macdev salt '*' parallels.create_snapshot macvm snap_name=macvm-updates desc='clean install with updates' runas=macdev
salt.modules.parallels.snapshot_id_to_name(name, snap_id, strict=False, runas=None) Attempt to convert a snapshot ID to a snapshot name.  If the snapshot has no name or if the ID is not found or invalid, an empty string will be returned
• name (str) -- Name/ID of VM whose snapshots are inspected
• snap_id (str) -- ID of the snapshot
• strict (bool) -- Raise an exception if a name cannot be found for the given snap_id
ID: {a5b8999f-5d95-4aff-82de-e515b0101b66} Name: original Date: 2016-03-04 10:50:34 Current: yes State: poweroff Description: original state
salt '*' parallels.snapshot_id_to_name macvm a5b8999f-5d95-4aff-82de-e515b0101b66 runas=macdev
salt.modules.parallels.snapshot_name_to_id(name, snap_name, strict=False, runas=None) Attempt to convert a snapshot name to a snapshot ID.  If the name is not found an empty string is returned.  If multiple snapshots share the same name, a list will be returned
• snap_name (str) -- Name of the snapshot
• strict (bool) -- Raise an exception if multiple snapshot IDs are found
salt '*' parallels.snapshot_id_to_name macvm original runas=macdev
salt.modules.parallels.start(name, runas=None) Start a VM
• name (str) -- Name/ID of VM to start
salt '*' parallels.start macvm runas=macdev
salt.modules.parallels.status(name, runas=None) Status of a VM
• name (str) -- Name/ID of VM whose status will be returned
salt '*' parallels.status macvm runas=macdev
salt.modules.parallels.stop(name, kill=False, runas=None) Stop a VM
• name (str) -- Name/ID of VM to stop
• kill (bool) -- Perform a hard shutdown
salt '*' parallels.stop macvm runas=macdev salt '*' parallels.stop macvm kill=True runas=macdev
salt.modules.parted_partition Module for managing partitions on POSIX-like systems.
• parted, partprobe, lsblk (usually parted and util-linux packages)
Some functions may not be available, depending on your version of parted.
Check the manpage for parted(8) for more information, or the online docs at:
http://www.gnu.org/software/parted/manual/html_chapter/parted_2.html
In light of parted not directly supporting partition IDs, some of this module has been written to utilize sfdisk instead. For further information, please reference the man page for sfdisk(8).
salt.modules.parted_partition.align_check(device, part_type, partition) Check if partition satisfies the alignment constraint of part_type.  Type must be "minimal" or "optimal".
salt '*' partition.align_check /dev/sda minimal 1
salt.modules.parted_partition.check(device, minor) Checks if the file system on partition <minor> has any errors.
salt '*' partition.check 1
salt.modules.parted_partition.cp(device, from_minor, to_minor) Copies the file system on the partition <from-minor> to partition <to-minor>, deleting the original contents of the destination partition.
salt '*' partition.cp /dev/sda 2 3
salt.modules.parted_partition.disk_set(device, flag, state) Changes a flag on selected device.
A flag can be either "on" or "off" (make sure to use proper quoting, see YAML Idiosyncrasies). Some or all of these flags will be available, depending on what disk label you are using.
Valid flags are:
• cylinder_alignment
• pmbr_boot
• implicit_partition_table
salt '*' partition.disk_set /dev/sda pmbr_boot '"on"'
salt.modules.parted_partition.disk_toggle(device, flag) Toggle the state of <flag> on <device>. Valid flags are the same as the disk_set command.
salt '*' partition.disk_toggle /dev/sda pmbr_boot
salt.modules.parted_partition.exists(device='') Check to see if the partition exists
salt '*' partition.exists /dev/sdb1
salt.modules.parted_partition.get_block_device() Retrieve a list of disk devices
salt '*' partition.get_block_device
salt.modules.parted_partition.get_id(device, minor) Prints the system ID for the partition. Some typical values are:
b: FAT32 (vfat) 7: HPFS/NTFS 82: Linux Swap 83: Linux 8e: Linux LVM fd: Linux RAID Auto
salt '*' partition.get_id /dev/sda 1
salt.modules.parted_partition.list_(device, unit=None) Prints partition information of given <device>
salt '*' partition.list /dev/sda salt '*' partition.list /dev/sda unit=s salt '*' partition.list /dev/sda unit=kB
salt.modules.parted_partition.mkfs(device, fs_type) Makes a file system <fs_type> on partition <device>, destroying all data that resides on that partition. <fs_type> must be one of "ext2", "fat32", "fat16", "linux-swap" or "reiserfs" (if libreiserfs is installed)
salt '*' partition.mkfs /dev/sda2 fat32
salt.modules.parted_partition.mklabel(device, label_type) Create a new disklabel (partition table) of label_type.
Type should be one of "aix", "amiga", "bsd", "dvh", "gpt", "loop", "mac", "msdos", "pc98", or "sun".
salt '*' partition.mklabel /dev/sda msdos
salt.modules.parted_partition.mkpart(device, part_type, fs_type=None, start=None, end=None) Make a part_type partition for filesystem fs_type, beginning at start and ending at end (by default in megabytes).  part_type should be one of "primary", "logical", or "extended".
salt '*' partition.mkpart /dev/sda primary fs_type=fat32 start=0 end=639 salt '*' partition.mkpart /dev/sda primary start=0 end=639
salt.modules.parted_partition.mkpartfs(device, part_type, fs_type=None, start=None, end=None) The mkpartfs actually is an alias to mkpart and is kept for compatibility.  To know the valid options and usage syntax read mkpart documentation.
salt '*' partition.mkpartfs /dev/sda primary fs_type=fat32 start=0 end=639 salt '*' partition.mkpartfs /dev/sda primary start=0 end=639
salt.modules.parted_partition.name(device, partition, name) Set the name of partition to name. This option works only on Mac, PC98, and GPT disklabels. The name can be placed in quotes, if necessary.
salt '*' partition.name /dev/sda 1 'My Documents'
salt.modules.parted_partition.probe(*devices) Ask the kernel to update its local partition data. When no args are specified all block devices are tried.
Caution: Generally only works on devices with no mounted partitions and may take a long time to return if specified devices are in use.
salt '*' partition.probe salt '*' partition.probe /dev/sda salt '*' partition.probe /dev/sda /dev/sdb
salt.modules.parted_partition.rescue(device, start, end) Rescue a lost partition that was located somewhere between start and end.  If a partition is found, parted will ask if you want to create an entry for it in the partition table.
salt '*' partition.rescue /dev/sda 0 8056
salt.modules.parted_partition.resize(device, minor, start, end) Resizes the partition with number <minor>.
The partition will start <start> from the beginning of the disk, and end <end> from the beginning of the disk. resize never changes the minor number.  Extended partitions can be resized, so long as the new extended partition completely contains all logical partitions.
salt '*' partition.resize /dev/sda 3 200 850
salt.modules.parted_partition.rm(device, minor) Removes the partition with number <minor>.
salt '*' partition.rm /dev/sda 5
salt.modules.parted_partition.set_(device, minor, flag, state) Changes a flag on the partition with number <minor>.
• root
• swap
• hidden
• raid
• lvm
• lba
• hp-service
• palo
• prep
• msftres
• bios_grub
• atvrecv
• diag
• legacy_boot
• msftdata
• irst
• esp
salt '*' partition.set /dev/sda 1 boot '"on"'
salt.modules.parted_partition.set_id(device, minor, system_id) Sets the system ID for the partition. Some typical values are:
salt '*' partition.set_id /dev/sda 1 83
salt.modules.parted_partition.system_types() List the system types that are supported by the installed version of sfdisk
salt '*' partition.system_types
salt.modules.parted_partition.toggle(device, partition, flag)
Toggle the state of <flag> on <partition>. Valid flags are the same as the set command.
salt '*' partition.toggle /dev/sda 1 boot
salt.modules.pcs Configure a Pacemaker/Corosync cluster with PCS Configure Pacemaker/Cororsync clusters with the Pacemaker/Cororsync conifguration system (PCS)
depends pcs
salt.modules.pcs.auth(nodes, pcsuser='hacluster', pcspasswd='hacluster', extra_args=None) Authorize nodes to the cluster
nodes  a list of nodes which should be authorized to the cluster
pcsuser user for communitcation with PCS (default: hacluster)
pcspasswd password for pcsuser (default: hacluster)
extra_args list of extra option for the 'pcs cluster auth' command. The newer cluster host command has no extra args and so will ignore it.
salt '*' pcs.auth nodes='[ node1.example.org node2.example.org ]' pcsuser=hacluster pcspasswd=hoonetorg extra_args=[ '--force' ]
salt.modules.pcs.cib_create(cibfile, scope='configuration', extra_args=None) Create a CIB-file from the current CIB of the cluster
cibfile name/path of the file containing the CIB
scope  specific section of the CIB (default: configuration)
extra_args additional options for creating the CIB-file
salt '*' pcs.cib_create cibfile='/tmp/VIP_apache_1.cib' scope=False
salt.modules.pcs.cib_push(cibfile, scope='configuration', extra_args=None) Push a CIB-file as the new CIB to the cluster
salt '*' pcs.cib_push cibfile='/tmp/VIP_apache_1.cib' scope=False
salt.modules.pcs.cluster_destroy(extra_args=None) Destroy corosync cluster using the pcs command
extra_args list of extra option for the 'pcs cluster destroy' command (only really --all)
salt '*' pcs.cluster_destroy extra_args=--all
salt.modules.pcs.cluster_node_add(node, extra_args=None) Add a node to the pacemaker cluster via pcs command
node   node that should be added
extra_args list of extra option for the 'pcs cluster node add' command
salt '*' pcs.cluster_node_add node=node2.example.org
salt.modules.pcs.cluster_setup(nodes, pcsclustername='pcscluster', extra_args=None) Setup pacemaker cluster via pcs command
nodes  a list of nodes which should be set up
pcsclustername Name of the Pacemaker cluster (default: pcscluster)
extra_args list of extra option for the 'pcs cluster setup' command
salt '*' pcs.cluster_setup nodes='[ node1.example.org node2.example.org ]' pcsclustername=pcscluster
salt.modules.pcs.config_show(cibfile=None) Show config of cluster
salt '*' pcs.config_show cibfile='/tmp/cib_for_galera'
salt.modules.pcs.is_auth(nodes, pcsuser='hacluster', pcspasswd='hacluster') Check if nodes are already authorized
nodes  a list of nodes to be checked for authorization to the cluster
salt '*' pcs.is_auth nodes='[node1.example.org node2.example.org]' pcsuser=hacluster pcspasswd=hoonetorg
salt.modules.pcs.item_create(item, item_id, item_type, create='create', extra_args=None, cibfile=None) Create an item via pcs command (mainly for use with the pcs state module)
item   config, property, resource, constraint etc.
item_id id of the item
item_type item type
create create command (create or set f.e., default: create)
extra_args additional options for the pcs command
cibfile use cibfile instead of the live CIB
salt.modules.pcs.item_show(item, item_id=None, item_type=None, show='show', extra_args=None, cibfile=None) Show an item via pcs command (mainly for use with the pcs state module)
show   show command (probably None, default: show or status for newer implementation)
salt.modules.pcs.prop_set(prop, value, extra_args=None, cibfile=None) Set the value of a cluster property
prop   name of the property
value  value of the property prop
extra_args additional options for the pcs property command
salt '*' pcs.prop_set prop='no-quorum-policy' value='ignore' cibfile='/tmp/2_node_cluster.cib'
salt.modules.pcs.prop_show(prop, extra_args=None, cibfile=None) Show the value of a cluster property
salt '*' pcs.prop_show cibfile='/tmp/2_node_cluster.cib' prop='no-quorum-policy' cibfile='/tmp/2_node_cluster.cib'
salt.modules.pcs.resource_create(resource_id, resource_type, resource_options=None, cibfile=None) Create a resource via pcs command
resource_id name for the resource
resource_type resource type (f.e. ocf:heartbeat:IPaddr2 or VirtualIP)
resource_options additional options for creating the resource
cibfile use cibfile instead of the live CIB for manipulation
salt '*' pcs.resource_create resource_id='galera' resource_type='ocf:heartbeat:galera' resource_options="['wsrep_cluster_address=gcomm://node1.example.org,node2.example.org,node3.example.org', '--master']" cibfile='/tmp/cib_for_galera.cib'
salt.modules.pcs.resource_show(resource_id, extra_args=None, cibfile=None) Show a resource via pcs command
resource_id name of the resource
salt '*' pcs.resource_show resource_id='galera' cibfile='/tmp/cib_for_galera.cib'
salt.modules.pcs.stonith_create(stonith_id, stonith_device_type, stonith_device_options=None, cibfile=None) Create a stonith resource via pcs command
stonith_id name for the stonith resource
stonith_device_type name of the stonith agent fence_eps, fence_xvm f.e.
stonith_device_options additional options for creating the stonith resource
salt '*' pcs.stonith_create stonith_id='eps_fence' stonith_device_type='fence_eps' stonith_device_options="['pcmk_host_map=node1.example.org:01;node2.example.org:02', 'ipaddr=myepsdevice.example.org', 'action=reboot', 'power_wait=5', 'verbose=1', 'debug=/var/log/pcsd/eps_fence.log', 'login=hidden', 'passwd=hoonetorg']" cibfile='/tmp/cib_for_stonith.cib'
salt.modules.pcs.stonith_show(stonith_id, extra_args=None, cibfile=None) Show the value of a cluster stonith
extra_args additional options for the pcs stonith command
salt '*' pcs.stonith_show stonith_id='eps_fence' cibfile='/tmp/2_node_cluster.cib'
salt.modules.pdbedit Manage accounts in Samba's passdb using pdbedit
platform posix
salt.modules.pdbedit.create(login, password, password_hashed=False, machine_account=False) Create user account
login  string login name
password string password
password_hashed boolean set if password is a nt hash instead of plain text
machine_account boolean set to create a machine trust account instead
salt '*' pdbedit.create zoe 9764951149F84E770889011E1DC4A927 nthash salt '*' pdbedit.create river  1sw4ll0w3d4bug
salt.modules.pdbedit.delete(login) Delete user account
salt '*' pdbedit.delete wash
salt.modules.pdbedit.generate_nt_hash(password) Generate a NT HASH
salt '*' pdbedit.generate_nt_hash my_passwd
salt.modules.pdbedit.get_user(login, hashes=False) Get user account details
hashes boolean include NTHASH and LMHASH in verbose output
salt '*' pdbedit.get kaylee
salt.modules.pdbedit.list_users(verbose=True, hashes=False) List user accounts
verbose boolean return all information
hashes boolean include NT HASH and LM HASH in verbose output
salt '*' pdbedit.list
salt.modules.pdbedit.modify(login, password=None, password_hashed=False, domain=None, profile=None, script=None, drive=None, homedir=None, fullname=None, account_desc=None, account_control=None, machine_sid=None, user_sid=None, reset_login_hours=False, reset_bad_password_count=False) Modify user account
domain string users domain
profile string profile path
script string logon script
drive  string home drive
homedir string home directory
fullname string full name
account_desc string account description
machine_sid string specify the machines new primary group SID or rid
user_sid string specify the users new primary group SID or rid
account_control string specify user account control properties
NOTE: Only the following can be set: - N: No password required - D: Account disabled - H: Home directory required - L: Automatic Locking - X: Password does not expire
reset_login_hours boolean reset the users allowed logon hours
reset_bad_password_count boolean reset the stored bad login counter
NOTE: if user is absent and password is provided, the user will be created
salt '*' pdbedit.modify inara fullname='Inara Serra' salt '*' pdbedit.modify simon password=r1v3r salt '*' pdbedit.modify jane drive='V:' homedir='\\serenity\jane\profile' salt '*' pdbedit.modify mal account_control=NX
salt.modules.pecl Manage PHP pecl extensions.
salt.modules.pecl.install(pecls, defaults=False, force=False, preferred_state='stable') New in version 0.17.0.
Installs one or several pecl extensions.
pecls  The pecl extensions to install.
defaults Use default answers for extensions such as pecl_http which ask questions before installation. Without this option, the pecl.installed state will hang indefinitely when trying to install these extensions.
force  Whether to force the installed version or not
salt '*' pecl.install fuse
salt.modules.pecl.list_(channel=None) List installed pecl extensions.
salt '*' pecl.list
salt.modules.pecl.uninstall(pecls) Uninstall one or several pecl extensions.
pecls  The pecl extensions to uninstall.
salt '*' pecl.uninstall fuse
salt.modules.pecl.update(pecls) Update one or several pecl extensions.
pecls  The pecl extensions to update.
salt '*' pecl.update fuse
salt.modules.peeringdb PeeringDB Module New in version 2019.2.0.
Execution module for the basic interaction with the PeeringDB API.
While for GET operations (the functions prefixed by get_) the credentials are optional, there are some specific details that are visible only to authenticated users. Moreover, the credentials are required when adding or updating information. That means, the module can equally work out of the box without any further configuration with the limitations imposed by the PeeringDB API.
For complete API documentation, please refer to https://www.peeringdb.com/apidocs/.
Configuration (in the opts or Pillar):
peeringdb: username: salt password: 5@1t
salt.modules.peeringdb.get_fac(**kwargs) Return the details of the facility identified using the search filters specified in the query.
NOTE: If no id or filter arguments are specified, it will return all the possible facilities registered in PeeringDB.
The available filters are documented at: https://www.peeringdb.com/apidocs/#!/netfac/netfac_list
salt '*' peeringdb.get_fac id=1774 salt '*' peeringdb.get_fac state=UT
salt.modules.peeringdb.get_ix(**kwargs) Return the details of an IX (Internet Exchange) using the search filters specified in the query.
NOTE: If no id or filter arguments are specified, it will return all the possible IXs registered in PeeringDB.
The available filters are documented at: https://www.peeringdb.com/apidocs/#!/ix/ix_list
salt '*' peeringdb.get_ix id=1 salt '*' peeringdb.get_ix city='Milwaukee'
salt.modules.peeringdb.get_ixfac(**kwargs) Return the details of an IX (Internet Exchange) facility using the search filters specified in the query.
NOTE: If no id or filter arguments are specified, it will return all the possible IX facilities registered in PeeringDB.
The available filters are documented at: https://www.peeringdb.com/apidocs/#!/ixfac/ixfac_list
salt '*' peeringdb.get_ixfac id=1 salt '*' peeringdb.get_ixfac city='Milwaukee'
salt.modules.peeringdb.get_ixlan(**kwargs) Return the details of an IX (Internet Exchange) together with the networks available in this location (and their details), using the search filters specified in the query.
NOTE: If no id or filter arguments are specified, it will return all the possible IX LAN facilities registered in PeeringDB.
The available filters are documented at: https://www.peeringdb.com/apidocs/#!/ixlan/ixlan_list
salt '*' peeringdb.get_ixlan id=780 salt '*' peeringdb.get_ixlan city='Milwaukee'
salt.modules.peeringdb.get_ixpfx(**kwargs) Return the details of an IX (Internet Exchange) together with the PeeringDB IDs of the networks available in this location, using the search filters specified in the query.
The available filters are documented at: https://www.peeringdb.com/apidocs/#!/ixpfx/ixpfx_list
salt '*' peeringdb.get_ixpfx id=780 salt '*' peeringdb.get_ixpfx city='Milwaukee'
salt.modules.peeringdb.get_net(**kwargs) Return the details of a network identified using the search filters specified in the query.
NOTE: If no id or filter arguments are specified, it will return all the possible networks registered in PeeringDB.
The available filters are documented at: https://www.peeringdb.com/apidocs/#!/net/net_list