golden hour

/opt/saltstack/salt/lib/python3.10/site-packages/salt/modules

File/Folder	Size	Actions
__init__.py	35 B
__pycache__	-
acme.py	12.74 KB
aix_group.py	4.12 KB
aix_shadow.py	1.93 KB
aixpkg.py	24.15 KB
aliases.py	5.07 KB
alternatives.py	5.71 KB
ansiblegate.py	19.51 KB
apache.py	12.47 KB
apcups.py	2.15 KB
apf.py	3.09 KB
apkpkg.py	16 KB
aptly.py	15.28 KB
aptpkg.py	116.64 KB
archive.py	48.63 KB
arista_pyeapi.py	22.06 KB
artifactory.py	24.78 KB
at.py	10.72 KB
at_solaris.py	8.51 KB
augeas_cfg.py	13.93 KB
aws_sqs.py	6.55 KB
azurearm_compute.py	20.8 KB
azurearm_dns.py	15.8 KB
azurearm_network.py	82.99 KB
azurearm_resource.py	35.75 KB
bamboohr.py	7.36 KB
baredoc.py	11.13 KB
bcache.py	28.97 KB
beacons.py	27.82 KB
bigip.py	69.11 KB
bluez_bluetooth.py	6.76 KB
boto3_elasticache.py	37.34 KB
boto3_elasticsearch.py	53.17 KB
boto3_route53.py	39.82 KB
boto3_sns.py	12.93 KB
boto_apigateway.py	61.86 KB
boto_asg.py	35.69 KB
boto_cfn.py	7.95 KB
boto_cloudfront.py	12.75 KB
boto_cloudtrail.py	14.45 KB
boto_cloudwatch.py	10.99 KB
boto_cloudwatch_event.py	9.48 KB
boto_cognitoidentity.py	14.63 KB
boto_datapipeline.py	6.94 KB
boto_dynamodb.py	14.98 KB
boto_ec2.py	79.27 KB
boto_efs.py	14.05 KB
boto_elasticache.py	23.69 KB
boto_elasticsearch_domain.py	15.85 KB
boto_elb.py	35.53 KB
boto_elbv2.py	10.78 KB
boto_iam.py	75.62 KB
boto_iot.py	26.2 KB
boto_kinesis.py	19.62 KB
boto_kms.py	17.29 KB
boto_lambda.py	35.05 KB
boto_rds.py	34.92 KB
boto_route53.py	32.55 KB
boto_s3.py	4.24 KB
boto_s3_bucket.py	31.8 KB
boto_secgroup.py	25.22 KB
boto_sns.py	7.22 KB
boto_sqs.py	6.43 KB
boto_ssm.py	3.63 KB
boto_vpc.py	113.08 KB
bower.py	5.85 KB
bridge.py	10.81 KB
bsd_shadow.py	6.25 KB
btrfs.py	33.66 KB
cabal.py	3.79 KB
capirca_acl.py	40.04 KB
cassandra_cql.py	54.16 KB
cassandra_mod.py	4.3 KB
celery.py	3.33 KB
ceph.py	15.82 KB
chassis.py	1.52 KB
chef.py	4.66 KB
chocolatey.py	41.55 KB
chronos.py	2.89 KB
chroot.py	11.73 KB
cimc.py	23.02 KB
ciscoconfparse_mod.py	14.79 KB
cisconso.py	3.83 KB
cloud.py	9.39 KB
cmdmod.py	163.73 KB
composer.py	10.31 KB
config.py	16.98 KB
consul.py	69.3 KB
container_resource.py	12.94 KB
cp.py	31.98 KB
cpan.py	5.54 KB
cron.py	28.09 KB
cryptdev.py	10.08 KB
csf.py	16.04 KB
cyg.py	8.32 KB
daemontools.py	5.41 KB
data.py	3.85 KB
datadog_api.py	7.76 KB
ddns.py	7.12 KB
deb_apache.py	7.41 KB
deb_postgres.py	4.18 KB
debconfmod.py	4.06 KB
debian_ip.py	64.91 KB
debian_service.py	6.55 KB
debuild_pkgbuild.py	34.68 KB
defaults.py	6.55 KB
devinfo.py	9.07 KB
devmap.py	627 B
dig.py	8.75 KB
disk.py	30.82 KB
djangomod.py	7.53 KB
dnsmasq.py	5.71 KB
dnsutil.py	11.51 KB
dockercompose.py	32.62 KB
dockermod.py	224.85 KB
dpkg_lowpkg.py	12.94 KB
drac.py	10.97 KB
dracr.py	38.53 KB
drbd.py	7.19 KB
dummyproxy_pkg.py	2.46 KB
dummyproxy_service.py	2.91 KB
ebuildpkg.py	38.74 KB
eix.py	1.58 KB
elasticsearch.py	51.44 KB
environ.py	8.96 KB
eselect.py	4.99 KB
esxcluster.py	1.66 KB
esxdatacenter.py	1.68 KB
esxi.py	2.79 KB
esxvm.py	1.63 KB
etcd_mod.py	8.56 KB
ethtool.py	11.12 KB
event.py	7.67 KB
extfs.py	8.78 KB
file.py	232.18 KB
firewalld.py	20.51 KB
freebsd_sysctl.py	4.99 KB
freebsd_update.py	6.19 KB
freebsdjail.py	7.16 KB
freebsdkmod.py	6.17 KB
freebsdpkg.py	17.04 KB
freebsdports.py	13.13 KB
freebsdservice.py	12.53 KB
freezer.py	10.2 KB
gcp_addon.py	4.07 KB
gem.py	10.6 KB
genesis.py	21.75 KB
gentoo_service.py	9.18 KB
gentoolkitmod.py	8.39 KB
git.py	172.01 KB
github.py	53.19 KB
glanceng.py	4.69 KB
glassfish.py	19.49 KB
glusterfs.py	19.55 KB
gnomedesktop.py	6.85 KB
google_chat.py	1.52 KB
gpg.py	39.09 KB
grafana4.py	30.27 KB
grains.py	21.81 KB
groupadd.py	11.87 KB
grub_legacy.py	3.08 KB
guestfs.py	2.37 KB
hadoop.py	3.76 KB
haproxyconn.py	10.17 KB
hashutil.py	6.77 KB
heat.py	25.25 KB
helm.py	39.27 KB
hg.py	7.16 KB
highstate_doc.py	22.76 KB
hosts.py	10.47 KB
http.py	3.76 KB
icinga2.py	4.46 KB
idem.py	1.75 KB
ifttt.py	2.28 KB
ilo.py	15.98 KB
incron.py	7.68 KB
influxdb08mod.py	15.07 KB
influxdbmod.py	16.13 KB
infoblox.py	17.53 KB
ini_manage.py	14.63 KB
inspectlib	-
inspector.py	8.19 KB
introspect.py	4.02 KB
iosconfig.py	14.78 KB
ipmi.py	25.47 KB
ipset.py	17.97 KB
iptables.py	57.44 KB
iwtools.py	3.99 KB
jboss7.py	20.51 KB
jboss7_cli.py	15.23 KB
jenkinsmod.py	11.9 KB
jinja.py	2.66 KB
jira_mod.py	7.07 KB
junos.py	73.96 KB
k8s.py	24.87 KB
kapacitor.py	5.37 KB
kerberos.py	5.42 KB
kernelpkg_linux_apt.py	6.71 KB
kernelpkg_linux_yum.py	7.26 KB
key.py	1007 B
keyboard.py	2.64 KB
keystone.py	43.14 KB
keystoneng.py	21.82 KB
keystore.py	7.18 KB
kmod.py	7.65 KB
kubeadm.py	34.64 KB
kubernetesmod.py	46.77 KB
launchctl_service.py	9.69 KB
layman.py	4.22 KB
ldap3.py	18.81 KB
ldapmod.py	5.9 KB
libcloud_compute.py	23.48 KB
libcloud_dns.py	9.73 KB
libcloud_loadbalancer.py	13.14 KB
libcloud_storage.py	12.16 KB
linux_acl.py	7.7 KB
linux_ip.py	5.55 KB
linux_lvm.py	17.86 KB
linux_service.py	4.64 KB
linux_shadow.py	12.96 KB
linux_sysctl.py	7.5 KB
localemod.py	11.84 KB
locate.py	2.58 KB
logadm.py	9.44 KB
logmod.py	1.25 KB
logrotate.py	7.72 KB
lvs.py	11.54 KB
lxc.py	147.27 KB
lxd.py	90.07 KB
mac_assistive.py	11.37 KB
mac_brew_pkg.py	19.91 KB
mac_desktop.py	2.77 KB
mac_group.py	6.62 KB
mac_keychain.py	6.39 KB
mac_pkgutil.py	2.84 KB
mac_portspkg.py	11.36 KB
mac_power.py	13.29 KB
mac_service.py	19.64 KB
mac_shadow.py	14.23 KB
mac_softwareupdate.py	14.52 KB
mac_sysctl.py	5.13 KB
mac_system.py	15.07 KB
mac_timezone.py	8.34 KB
mac_user.py	16.41 KB
mac_xattr.py	6.27 KB
macdefaults.py	2.33 KB
macpackage.py	6.66 KB
makeconf.py	17.31 KB
mandrill.py	6.31 KB
marathon.py	5.36 KB
match.py	13 KB
mattermost.py	3.4 KB
mdadm_raid.py	9.86 KB
mdata.py	3.38 KB
memcached.py	6.13 KB
mine.py	18.84 KB
minion.py	7.68 KB
mod_random.py	7.18 KB
modjk.py	12.48 KB
mongodb.py	29.75 KB
monit.py	5.51 KB
moosefs.py	3.87 KB
mount.py	58.44 KB
mssql.py	14.64 KB
msteams.py	2.11 KB
munin.py	2.4 KB
mysql.py	90.66 KB
nacl.py	9.72 KB
nagios.py	6.53 KB
nagios_rpc.py	5.09 KB
namecheap_domains.py	12.84 KB
namecheap_domains_dns.py	5.93 KB
namecheap_domains_ns.py	4.51 KB
namecheap_ssl.py	25.69 KB
namecheap_users.py	2.4 KB
napalm_bgp.py	9.72 KB
napalm_formula.py	11.33 KB
napalm_mod.py	61.37 KB
napalm_netacl.py	28.59 KB
napalm_network.py	93.22 KB
napalm_ntp.py	10.22 KB
napalm_probes.py	13.25 KB
napalm_route.py	5.09 KB
napalm_snmp.py	7.05 KB
napalm_users.py	6.49 KB
napalm_yang_mod.py	20.28 KB
netaddress.py	1.6 KB
netbox.py	32.22 KB
netbsd_sysctl.py	3.92 KB
netbsdservice.py	6.43 KB
netmiko_mod.py	19.61 KB
netscaler.py	27.02 KB
network.py	63.42 KB
neutron.py	44.92 KB
neutronng.py	15.02 KB
nexus.py	22.95 KB
nfs3.py	3.9 KB
nftables.py	33.58 KB
nginx.py	3.83 KB
nilrt_ip.py	36.18 KB
nix.py	8.03 KB
nova.py	19.6 KB
npm.py	10.4 KB
nspawn.py	41.35 KB
nxos.py	24.65 KB
nxos_api.py	14.72 KB
nxos_upgrade.py	14.74 KB
omapi.py	3.6 KB
openbsd_sysctl.py	3.74 KB
openbsdpkg.py	10.97 KB
openbsdrcctl_service.py	6.33 KB
openbsdservice.py	8.31 KB
openscap.py	2.81 KB
openstack_config.py	3.21 KB
openstack_mng.py	2.71 KB
openvswitch.py	17.19 KB
opkg.py	49.67 KB
opsgenie.py	3.29 KB
oracle.py	5.82 KB
osquery.py	24.93 KB
out.py	2.53 KB
pacmanpkg.py	31.92 KB
pagerduty.py	4.7 KB
pagerduty_util.py	13.48 KB
pam.py	2.01 KB
panos.py	61.05 KB
parallels.py	19.85 KB
parted_partition.py	21.53 KB
pcs.py	14.11 KB
pdbedit.py	10.79 KB
pecl.py	3.79 KB
peeringdb.py	8.39 KB
pf.py	9.51 KB
philips_hue.py	1.55 KB
pillar.py	21.37 KB
pip.py	53.42 KB
pkg_resource.py	12.3 KB
pkgin.py	17.29 KB
pkgng.py	61.07 KB
pkgutil.py	9.85 KB
portage_config.py	22.73 KB
postfix.py	16.24 KB
postgres.py	88.24 KB
poudriere.py	7.85 KB
powerpath.py	2.57 KB
proxy.py	11.49 KB
ps.py	20.89 KB
publish.py	10.25 KB
puppet.py	10.9 KB
purefa.py	33.59 KB
purefb.py	13.69 KB
pushbullet.py	1.88 KB
pushover_notify.py	3.48 KB
pw_group.py	4.62 KB
pw_user.py	12.47 KB
pyenv.py	6.93 KB
qemu_img.py	1.53 KB
qemu_nbd.py	3.28 KB
quota.py	6.43 KB
rabbitmq.py	38.4 KB
rallydev.py	6.09 KB
random_org.py	23.76 KB
rbac_solaris.py	16.05 KB
rbenv.py	10.75 KB
rdp.py	6.08 KB
rebootmgr.py	7.68 KB
redismod.py	16.36 KB
reg.py	16.36 KB
rest_pkg.py	2.26 KB
rest_sample_utils.py	558 B
rest_service.py	3.63 KB
restartcheck.py	24.1 KB
restconf.py	3.15 KB
ret.py	1.27 KB
rh_ip.py	38.55 KB
rh_service.py	16.61 KB
riak.py	5.19 KB
rpm_lowpkg.py	27.67 KB
rpmbuild_pkgbuild.py	24.53 KB
rsync.py	8.04 KB
runit.py	17.17 KB
rvm.py	11.1 KB
s3.py	9.93 KB
s6.py	3.62 KB
salt_proxy.py	4.48 KB
salt_version.py	4.58 KB
saltcheck.py	46.66 KB
saltcloudmod.py	954 B
saltutil.py	57.49 KB
schedule.py	50.81 KB
scp_mod.py	6.22 KB
scsi.py	2.66 KB
sdb.py	2.48 KB
seed.py	8.87 KB
selinux.py	24.2 KB
sensehat.py	7.79 KB
sensors.py	1.3 KB
serverdensity_device.py	8.1 KB
servicenow.py	4.36 KB
slack_notify.py	7.83 KB
slackware_service.py	6.84 KB
slsutil.py	19.04 KB
smartos_imgadm.py	12.04 KB
smartos_nictagadm.py	6.46 KB
smartos_virt.py	5.21 KB
smartos_vmadm.py	26.2 KB
smbios.py	10.05 KB
smf_service.py	8.52 KB
smtp.py	5.41 KB
snapper.py	27.14 KB
solaris_fmadm.py	11.2 KB
solaris_group.py	2.8 KB
solaris_shadow.py	7.98 KB
solaris_system.py	3.72 KB
solaris_user.py	11.06 KB
solarisipspkg.py	18.68 KB
solarispkg.py	15.4 KB
solr.py	45.54 KB
solrcloud.py	14.63 KB
splunk.py	8.14 KB
splunk_search.py	8.76 KB
sqlite3.py	2.54 KB
ssh.py	43.89 KB
ssh_pkg.py	1.08 KB
ssh_service.py	3.39 KB
state.py	82.34 KB
status.py	57.79 KB
statuspage.py	14.67 KB
supervisord.py	11.15 KB
suse_apache.py	2.45 KB
suse_ip.py	35.72 KB
svn.py	10.75 KB
swarm.py	13.5 KB
swift.py	5.53 KB
sysbench.py	6.62 KB
sysfs.py	6.61 KB
syslog_ng.py	31.52 KB
sysmod.py	22.59 KB
sysrc.py	3.38 KB
system.py	19.28 KB
system_profiler.py	3.54 KB
systemd_service.py	46.29 KB
telegram.py	3.28 KB
telemetry.py	12.87 KB
temp.py	831 B
test.py	15.4 KB
test_virtual.py	237 B
testinframod.py	9.92 KB
textfsm_mod.py	16.22 KB
timezone.py	19.98 KB
tls.py	58.63 KB
tomcat.py	18.59 KB
trafficserver.py	10.44 KB
transactional_update.py	35.83 KB
travisci.py	2.05 KB
tuned.py	2.34 KB
twilio_notify.py	2.95 KB
udev.py	3.72 KB
upstart_service.py	16.92 KB
uptime.py	3.23 KB
useradd.py	22.63 KB
uwsgi.py	996 B
vagrant.py	20.4 KB
varnish.py	3.08 KB
vault.py	15.61 KB
vbox_guest.py	10.55 KB
vboxmanage.py	14.71 KB
vcenter.py	1.61 KB
victorops.py	6.54 KB
virt.py	287.71 KB
virtualenv_mod.py	15.09 KB
vmctl.py	9.56 KB
vsphere.py	380.41 KB
webutil.py	3.66 KB
win_auditpol.py	4.74 KB
win_autoruns.py	2.29 KB
win_certutil.py	4.55 KB
win_dacl.py	32.27 KB
win_disk.py	1.8 KB
win_dism.py	20.7 KB
win_dns_client.py	4.19 KB
win_dsc.py	27.54 KB
win_event.py	22.32 KB
win_file.py	64.39 KB
win_firewall.py	20.15 KB
win_groupadd.py	11.27 KB
win_iis.py	68.78 KB
win_ip.py	11.43 KB
win_lgpo.py	491.76 KB
win_lgpo_reg.py	17.9 KB
win_license.py	2.72 KB
win_network.py	13.9 KB
win_ntp.py	1.8 KB
win_path.py	11.12 KB
win_pkg.py	86.43 KB
win_pki.py	15.8 KB
win_powercfg.py	9.85 KB
win_psget.py	8.97 KB
win_servermanager.py	14.21 KB
win_service.py	32.96 KB
win_shadow.py	3.03 KB
win_shortcut.py	16.49 KB
win_smtp_server.py	17.67 KB
win_snmp.py	13.38 KB
win_status.py	16.94 KB
win_system.py	40.61 KB
win_task.py	79.17 KB
win_timezone.py	13.3 KB
win_useradd.py	27.39 KB
win_wua.py	38.29 KB
win_wusa.py	5.88 KB
winrepo.py	6.09 KB
wordpress.py	4.71 KB
x509.py	63.1 KB
x509_v2.py	74.15 KB
xapi_virt.py	24.07 KB
xbpspkg.py	15.84 KB
xfs.py	15.35 KB
xml.py	2.14 KB
xmpp.py	5.28 KB
yaml.py	1.94 KB
yumpkg.py	116.5 KB
zabbix.py	97.55 KB
zcbuildout.py	28.16 KB
zenoss.py	5.64 KB
zfs.py	34.44 KB
zk_concurrency.py	11.16 KB
znc.py	2.26 KB
zoneadm.py	15.05 KB
zonecfg.py	21.85 KB
zookeeper.py	14.72 KB
zpool.py	44.02 KB
zypperpkg.py	94.87 KB

Edit: panos.py

"""
Module to provide Palo Alto compatibility to Salt

:codeauthor: ``Spencer Ervin <spencer_ervin@hotmail.com>``
:maturity:   new
:depends:    none
:platform:   unix

.. versionadded:: 2018.3.0

Configuration
=============

This module accepts connection configuration details either as
parameters, or as configuration settings in pillar as a Salt proxy.
Options passed into opts will be ignored if options are passed into pillar.

.. seealso::
    :py:mod:`Palo Alto Proxy Module <salt.proxy.panos>`

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.

"""

import logging
import time

import salt.proxy.panos
import salt.utils.platform
from salt.exceptions import CommandExecutionError

log = logging.getLogger(__name__)

__virtualname__ = "panos"

def __virtual__():
    """
    Will load for the panos proxy minions.
    """
    try:
        if salt.utils.platform.is_proxy() and __opts__["proxy"]["proxytype"] == "panos":
            return __virtualname__
    except KeyError:
        pass

return (
        False,
        "The panos execution module can only be loaded for panos proxy minions.",
    )

def _get_job_results(query=None):
    """
    Executes a query that requires a job for completion. This function will wait for the job to complete
    and return the results.
    """
    if not query:
        raise CommandExecutionError("Query parameters cannot be empty.")

response = __proxy__["panos.call"](query)

# If the response contains a job, we will wait for the results
    if "result" in response and "job" in response["result"]:
        jid = response["result"]["job"]

while get_job(jid)["result"]["job"]["status"] != "FIN":
            time.sleep(5)

return get_job(jid)
    else:
        return response

def add_config_lock():
    """
    Prevent other users from changing configuration until the lock is released.

CLI Example:

.. code-block:: bash

salt '*' panos.add_config_lock

"""
    query = {
        "type": "op",
        "cmd": "<request><config-lock><add></add></config-lock></request>",
    }

return __proxy__["panos.call"](query)

def check_antivirus():
    """
    Get anti-virus information from PaloAlto Networks server

CLI Example:

.. code-block:: bash

salt '*' panos.check_antivirus

"""
    query = {
        "type": "op",
        "cmd": "<request><anti-virus><upgrade><check></check></upgrade></anti-virus></request>",
    }

return __proxy__["panos.call"](query)

def check_software():
    """
    Get software information from PaloAlto Networks server.

CLI Example:

.. code-block:: bash

salt '*' panos.check_software

"""
    query = {
        "type": "op",
        "cmd": (
            "<request><system><software><check></check></software></system></request>"
        ),
    }

return __proxy__["panos.call"](query)

def clear_commit_tasks():
    """
    Clear all commit tasks.

CLI Example:

.. code-block:: bash

salt '*' panos.clear_commit_tasks

"""
    query = {
        "type": "op",
        "cmd": "<request><clear-commit-tasks></clear-commit-tasks></request>",
    }

return __proxy__["panos.call"](query)

def commit():
    """
    Commits the candidate configuration to the running configuration.

CLI Example:

.. code-block:: bash

salt '*' panos.commit

"""
    query = {"type": "commit", "cmd": "<commit></commit>"}

return _get_job_results(query)

def 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.

CLI Example:

.. code-block:: bash

salt '*' panos.deactivate_license key_name=License_File_Name.key

"""

_required_version = "7.0.0"
    if not __proxy__["panos.is_required_version"](_required_version):
        return (
            False,
            "The panos device requires version {} or greater for this command.".format(
                _required_version
            ),
        )

if not key_name:
        return False, "You must specify a key_name."
    else:
        query = {
            "type": "op",
            "cmd": (
                "<request><license><deactivate><key><features><member>{}</member></features>"
                "</key></deactivate></license></request>".format(key_name)
            ),
        }

return __proxy__["panos.call"](query)

def delete_license(key_name=None):
    """
    Remove license keys on disk.

key_name(str): The file name of the license key to be deleted.

CLI Example:

.. code-block:: bash

salt '*' panos.delete_license key_name=License_File_Name.key

"""

if not key_name:
        return False, "You must specify a key_name."
    else:
        query = {
            "type": "op",
            "cmd": "<delete><license><key>{}</key></license></delete>".format(key_name),
        }

return __proxy__["panos.call"](query)

def download_antivirus():
    """
    Download the most recent anti-virus package.

CLI Example:

.. code-block:: bash

salt '*' panos.download_antivirus

"""
    query = {
        "type": "op",
        "cmd": (
            "<request><anti-virus><upgrade><download>"
            "<latest></latest></download></upgrade></anti-virus></request>"
        ),
    }

return _get_job_results(query)

def download_software_file(filename=None, synch=False):
    """
    Download software packages by filename.

Args:
        filename(str): The filename of the PANOS file to download.

synch (bool): If true then the file will synch to the peer unit.

CLI Example:

.. code-block:: bash

salt '*' panos.download_software_file PanOS_5000-8.0.0
        salt '*' panos.download_software_file PanOS_5000-8.0.0 True

"""
    if not filename:
        raise CommandExecutionError("Filename option must not be none.")

if not isinstance(synch, bool):
        raise CommandExecutionError("Synch option must be boolean..")

if synch is True:
        query = {
            "type": "op",
            "cmd": (
                "<request><system><software><download>"
                "<file>{}</file></download></software></system></request>".format(
                    filename
                )
            ),
        }
    else:
        query = {
            "type": "op",
            "cmd": (
                "<request><system><software><download><sync-to-peer>yes</sync-to-peer>"
                "<file>{}</file></download></software></system></request>".format(
                    filename
                )
            ),
        }

return _get_job_results(query)

def download_software_version(version=None, synch=False):
    """
    Download software packages by version number.

Args:
        version(str): The version of the PANOS file to download.

synch (bool): If true then the file will synch to the peer unit.

CLI Example:

.. code-block:: bash

salt '*' panos.download_software_version 8.0.0
        salt '*' panos.download_software_version 8.0.0 True

"""
    if not version:
        raise CommandExecutionError("Version option must not be none.")

if not isinstance(synch, bool):
        raise CommandExecutionError("Synch option must be boolean..")

if synch is True:
        query = {
            "type": "op",
            "cmd": (
                "<request><system><software><download>"
                "<version>{}</version></download></software></system></request>".format(
                    version
                )
            ),
        }
    else:
        query = {
            "type": "op",
            "cmd": (
                "<request><system><software><download><sync-to-peer>yes</sync-to-peer>"
                "<version>{}</version></download></software></system></request>".format(
                    version
                )
            ),
        }

return _get_job_results(query)

def fetch_license(auth_code=None):
    """
    Get new license(s) using from the Palo Alto Network Server.

auth_code
        The license authorization code.

CLI Example:

.. code-block:: bash

salt '*' panos.fetch_license
        salt '*' panos.fetch_license auth_code=foobar

"""
    if not auth_code:
        query = {
            "type": "op",
            "cmd": "<request><license><fetch></fetch></license></request>",
        }
    else:
        query = {
            "type": "op",
            "cmd": (
                "<request><license><fetch><auth-code>{}</auth-code></fetch></license>"
                "</request>".format(auth_code)
            ),
        }

return __proxy__["panos.call"](query)

def 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.

CLI Example:

.. code-block:: bash

salt '*' panos.get_address myhost
        salt '*' panos.get_address myhost 3

"""
    query = {
        "type": "config",
        "action": "get",
        "xpath": (
            "/config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys{}']/"
            "address/entry[@name='{}']".format(vsys, address)
        ),
    }

return __proxy__["panos.call"](query)

def 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.

vsys(str): The string representation of the VSYS ID.

CLI Example:

.. code-block:: bash

salt '*' panos.get_address_group foobar
        salt '*' panos.get_address_group foobar 3

"""
    query = {
        "type": "config",
        "action": "get",
        "xpath": (
            "/config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys{}']/"
            "address-group/entry[@name='{}']".format(vsys, addressgroup)
        ),
    }

return __proxy__["panos.call"](query)

def get_admins_active():
    """
    Show active administrators.

CLI Example:

.. code-block:: bash

salt '*' panos.get_admins_active

"""
    query = {"type": "op", "cmd": "<show><admins></admins></show>"}

return __proxy__["panos.call"](query)

def get_admins_all():
    """
    Show all administrators.

CLI Example:

.. code-block:: bash

salt '*' panos.get_admins_all

"""
    query = {"type": "op", "cmd": "<show><admins><all></all></admins></show>"}

return __proxy__["panos.call"](query)

def get_antivirus_info():
    """
    Show information about available anti-virus packages.

CLI Example:

.. code-block:: bash

salt '*' panos.get_antivirus_info

"""
    query = {
        "type": "op",
        "cmd": "<request><anti-virus><upgrade><info></info></upgrade></anti-virus></request>",
    }

return __proxy__["panos.call"](query)

def get_arp():
    """
    Show ARP information.

CLI Example:

.. code-block:: bash

salt '*' panos.get_arp

"""
    query = {"type": "op", "cmd": "<show><arp><entry name = 'all'/></arp></show>"}

return __proxy__["panos.call"](query)

def get_cli_idle_timeout():
    """
    Show timeout information for this administrative session.

CLI Example:

.. code-block:: bash

salt '*' panos.get_cli_idle_timeout

"""
    query = {
        "type": "op",
        "cmd": "<show><cli><idle-timeout></idle-timeout></cli></show>",
    }

return __proxy__["panos.call"](query)

def get_cli_permissions():
    """
    Show cli administrative permissions.

CLI Example:

.. code-block:: bash

salt '*' panos.get_cli_permissions

"""
    query = {"type": "op", "cmd": "<show><cli><permissions></permissions></cli></show>"}

return __proxy__["panos.call"](query)

def get_disk_usage():
    """
    Report filesystem disk space usage.

CLI Example:

.. code-block:: bash

salt '*' panos.get_disk_usage

"""
    query = {
        "type": "op",
        "cmd": "<show><system><disk-space></disk-space></system></show>",
    }

return __proxy__["panos.call"](query)

def get_dns_server_config():
    """
    Get the DNS server configuration from the candidate configuration.

CLI Example:

.. code-block:: bash

salt '*' panos.get_dns_server_config

"""
    query = {
        "type": "config",
        "action": "get",
        "xpath": "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/dns-setting/servers",
    }

return __proxy__["panos.call"](query)

def get_domain_config():
    """
    Get the domain name configuration from the candidate configuration.

CLI Example:

.. code-block:: bash

salt '*' panos.get_domain_config

"""
    query = {
        "type": "config",
        "action": "get",
        "xpath": "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/domain",
    }

return __proxy__["panos.call"](query)

def get_dos_blocks():
    """
    Show the DoS block-ip table.

CLI Example:

.. code-block:: bash

salt '*' panos.get_dos_blocks

"""
    query = {
        "type": "op",
        "cmd": "<show><dos-block-table><all></all></dos-block-table></show>",
    }

return __proxy__["panos.call"](query)

def get_fqdn_cache():
    """
    Print FQDNs used in rules and their IPs.

CLI Example:

.. code-block:: bash

salt '*' panos.get_fqdn_cache

"""
    query = {
        "type": "op",
        "cmd": "<request><system><fqdn><show></show></fqdn></system></request>",
    }

return __proxy__["panos.call"](query)

def get_ha_config():
    """
    Get the high availability configuration.

CLI Example:

.. code-block:: bash

salt '*' panos.get_ha_config

"""
    query = {
        "type": "config",
        "action": "get",
        "xpath": "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/high-availability",
    }

return __proxy__["panos.call"](query)

def get_ha_link():
    """
     Show high-availability link-monitoring state.

CLI Example:

.. code-block:: bash

salt '*' panos.get_ha_link

"""
    query = {
        "type": "op",
        "cmd": "<show><high-availability><link-monitoring></link-monitoring></high-availability></show>",
    }

return __proxy__["panos.call"](query)

def get_ha_path():
    """
    Show high-availability path-monitoring state.

CLI Example:

.. code-block:: bash

salt '*' panos.get_ha_path

"""
    query = {
        "type": "op",
        "cmd": "<show><high-availability><path-monitoring></path-monitoring></high-availability></show>",
    }

return __proxy__["panos.call"](query)

def get_ha_state():
    """
    Show high-availability state information.

CLI Example:

.. code-block:: bash

salt '*' panos.get_ha_state

"""

query = {
        "type": "op",
        "cmd": "<show><high-availability><state></state></high-availability></show>",
    }

return __proxy__["panos.call"](query)

def get_ha_transitions():
    """
    Show high-availability transition statistic information.

CLI Example:

.. code-block:: bash

salt '*' panos.get_ha_transitions

"""

query = {
        "type": "op",
        "cmd": "<show><high-availability><transitions></transitions></high-availability></show>",
    }

return __proxy__["panos.call"](query)

def get_hostname():
    """
    Get the hostname of the device.

CLI Example:

.. code-block:: bash

salt '*' panos.get_hostname

"""
    query = {
        "type": "config",
        "action": "get",
        "xpath": "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/hostname",
    }

return __proxy__["panos.call"](query)

def get_interface_counters(name="all"):
    """
    Get the counter statistics for interfaces.

Args:
        name (str): The name of the interface to view. By default, all interface statistics are viewed.

CLI Example:

.. code-block:: bash

salt '*' panos.get_interface_counters
        salt '*' panos.get_interface_counters ethernet1/1

"""
    query = {
        "type": "op",
        "cmd": "<show><counter><interface>{}</interface></counter></show>".format(name),
    }

return __proxy__["panos.call"](query)

def get_interfaces(name="all"):
    """
    Show interface information.

Args:
        name (str): The name of the interface to view. By default, all interface statistics are viewed.

CLI Example:

.. code-block:: bash

salt '*' panos.get_interfaces
        salt '*' panos.get_interfaces ethernet1/1

"""
    query = {
        "type": "op",
        "cmd": "<show><interface>{}</interface></show>".format(name),
    }

return __proxy__["panos.call"](query)

def get_job(jid=None):
    """
    List all a single job by ID.

jid
        The ID of the job to retrieve.

CLI Example:

.. code-block:: bash

salt '*' panos.get_job jid=15

"""
    if not jid:
        raise CommandExecutionError("ID option must not be none.")

query = {"type": "op", "cmd": "<show><jobs><id>{}</id></jobs></show>".format(jid)}

return __proxy__["panos.call"](query)

def 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.

CLI Example:

.. code-block:: bash

salt '*' panos.get_jobs
        salt '*' panos.get_jobs state=pending

"""
    if state.lower() == "all":
        query = {"type": "op", "cmd": "<show><jobs><all></all></jobs></show>"}
    elif state.lower() == "pending":
        query = {"type": "op", "cmd": "<show><jobs><pending></pending></jobs></show>"}
    elif state.lower() == "processed":
        query = {
            "type": "op",
            "cmd": "<show><jobs><processed></processed></jobs></show>",
        }
    else:
        raise CommandExecutionError(
            "The state parameter must be all, pending, or processed."
        )

return __proxy__["panos.call"](query)

def get_lacp():
    """
    Show LACP state.

CLI Example:

.. code-block:: bash

salt '*' panos.get_lacp

"""
    query = {
        "type": "op",
        "cmd": "<show><lacp><aggregate-ethernet>all</aggregate-ethernet></lacp></show>",
    }

return __proxy__["panos.call"](query)

def get_license_info():
    """
    Show information about owned license(s).

CLI Example:

.. code-block:: bash

salt '*' panos.get_license_info

"""
    query = {"type": "op", "cmd": "<request><license><info></info></license></request>"}

return __proxy__["panos.call"](query)

def get_license_tokens():
    """
    Show license token files for manual license deactivation.

CLI Example:

.. code-block:: bash

salt '*' panos.get_license_tokens

"""
    query = {
        "type": "op",
        "cmd": "<show><license-token-files></license-token-files></show>",
    }

return __proxy__["panos.call"](query)

def get_lldp_config():
    """
    Show lldp config for interfaces.

CLI Example:

.. code-block:: bash

salt '*' panos.get_lldp_config

"""
    query = {"type": "op", "cmd": "<show><lldp><config>all</config></lldp></show>"}

return __proxy__["panos.call"](query)

def get_lldp_counters():
    """
    Show lldp counters for interfaces.

CLI Example:

.. code-block:: bash

salt '*' panos.get_lldp_counters

"""
    query = {"type": "op", "cmd": "<show><lldp><counters>all</counters></lldp></show>"}

return __proxy__["panos.call"](query)

def get_lldp_local():
    """
    Show lldp local info for interfaces.

CLI Example:

.. code-block:: bash

salt '*' panos.get_lldp_local

"""
    query = {"type": "op", "cmd": "<show><lldp><local>all</local></lldp></show>"}

return __proxy__["panos.call"](query)

def get_lldp_neighbors():
    """
    Show lldp neighbors info for interfaces.

CLI Example:

.. code-block:: bash

salt '*' panos.get_lldp_neighbors

"""
    query = {
        "type": "op",
        "cmd": "<show><lldp><neighbors>all</neighbors></lldp></show>",
    }

return __proxy__["panos.call"](query)

def get_local_admins():
    """
    Show all local administrator accounts.

CLI Example:

.. code-block:: bash

salt '*' panos.get_local_admins

"""
    admin_list = get_users_config()
    response = []

if "users" not in admin_list["result"]:
        return response

if isinstance(admin_list["result"]["users"]["entry"], list):
        for entry in admin_list["result"]["users"]["entry"]:
            response.append(entry["name"])
    else:
        response.append(admin_list["result"]["users"]["entry"]["name"])

return response

def get_logdb_quota():
    """
    Report the logdb quotas.

CLI Example:

.. code-block:: bash

salt '*' panos.get_logdb_quota

"""
    query = {
        "type": "op",
        "cmd": "<show><system><logdb-quota></logdb-quota></system></show>",
    }

return __proxy__["panos.call"](query)

def get_master_key():
    """
    Get the master key properties.

CLI Example:

.. code-block:: bash

salt '*' panos.get_master_key

"""
    query = {
        "type": "op",
        "cmd": "<show><system><masterkey-properties></masterkey-properties></system></show>",
    }

return __proxy__["panos.call"](query)

def get_ntp_config():
    """
    Get the NTP configuration from the candidate configuration.

CLI Example:

.. code-block:: bash

salt '*' panos.get_ntp_config

"""
    query = {
        "type": "config",
        "action": "get",
        "xpath": "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/ntp-servers",
    }

return __proxy__["panos.call"](query)

def get_ntp_servers():
    """
    Get list of configured NTP servers.

CLI Example:

.. code-block:: bash

salt '*' panos.get_ntp_servers

"""
    query = {"type": "op", "cmd": "<show><ntp></ntp></show>"}

return __proxy__["panos.call"](query)

def get_operational_mode():
    """
    Show device operational mode setting.

CLI Example:

.. code-block:: bash

salt '*' panos.get_operational_mode

"""
    query = {"type": "op", "cmd": "<show><operational-mode></operational-mode></show>"}

return __proxy__["panos.call"](query)

def get_panorama_status():
    """
    Show panorama connection status.

CLI Example:

.. code-block:: bash

salt '*' panos.get_panorama_status

"""
    query = {"type": "op", "cmd": "<show><panorama-status></panorama-status></show>"}

return __proxy__["panos.call"](query)

def get_permitted_ips():
    """
    Get the IP addresses that are permitted to establish management connections to the device.

CLI Example:

.. code-block:: bash

salt '*' panos.get_permitted_ips

"""
    query = {
        "type": "config",
        "action": "get",
        "xpath": "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/permitted-ip",
    }

return __proxy__["panos.call"](query)

def get_platform():
    """
    Get the platform model information and limitations.

CLI Example:

.. code-block:: bash

salt '*' panos.get_platform

"""
    query = {
        "type": "config",
        "action": "get",
        "xpath": "/config/devices/entry[@name='localhost.localdomain']/platform",
    }

return __proxy__["panos.call"](query)

def 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.

CLI Example:

.. code-block:: bash

salt '*' panos.get_predefined_application saltstack

"""
    query = {
        "type": "config",
        "action": "get",
        "xpath": "/config/predefined/application/entry[@name='{}']".format(application),
    }

return __proxy__["panos.call"](query)

def get_security_rule(rulename=None, vsys="1"):
    """
    Get the candidate configuration for the specified security rule.

rulename(str): The name of the security rule.

vsys(str): The string representation of the VSYS ID.

CLI Example:

.. code-block:: bash

salt '*' panos.get_security_rule rule01
        salt '*' panos.get_security_rule rule01 3

"""
    query = {
        "type": "config",
        "action": "get",
        "xpath": (
            "/config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys{}']/"
            "rulebase/security/rules/entry[@name='{}']".format(vsys, rulename)
        ),
    }

return __proxy__["panos.call"](query)

def 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.

vsys(str): The string representation of the VSYS ID.

CLI Example:

.. code-block:: bash

salt '*' panos.get_service tcp-443
        salt '*' panos.get_service tcp-443 3

"""
    query = {
        "type": "config",
        "action": "get",
        "xpath": (
            "/config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys{}']/"
            "service/entry[@name='{}']".format(vsys, service)
        ),
    }

return __proxy__["panos.call"](query)

def 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.

vsys(str): The string representation of the VSYS ID.

CLI Example:

.. code-block:: bash

salt '*' panos.get_service_group foobar
        salt '*' panos.get_service_group foobar 3

"""
    query = {
        "type": "config",
        "action": "get",
        "xpath": (
            "/config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys{}']/"
            "service-group/entry[@name='{}']".format(vsys, servicegroup)
        ),
    }

return __proxy__["panos.call"](query)

def get_session_info():
    """
    Show device session statistics.

CLI Example:

.. code-block:: bash

salt '*' panos.get_session_info

"""
    query = {"type": "op", "cmd": "<show><session><info></info></session></show>"}

return __proxy__["panos.call"](query)

def get_snmp_config():
    """
    Get the SNMP configuration from the device.

CLI Example:

.. code-block:: bash

salt '*' panos.get_snmp_config

"""
    query = {
        "type": "config",
        "action": "get",
        "xpath": "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/snmp-setting",
    }

return __proxy__["panos.call"](query)

def get_software_info():
    """
    Show information about available software packages.

CLI Example:

.. code-block:: bash

salt '*' panos.get_software_info

"""
    query = {
        "type": "op",
        "cmd": "<request><system><software><info></info></software></system></request>",
    }

return __proxy__["panos.call"](query)

def get_system_date_time():
    """
    Get the system date/time.

CLI Example:

.. code-block:: bash

salt '*' panos.get_system_date_time

"""
    query = {"type": "op", "cmd": "<show><clock></clock></show>"}

return __proxy__["panos.call"](query)

def get_system_files():
    """
    List important files in the system.

CLI Example:

.. code-block:: bash

salt '*' panos.get_system_files

"""
    query = {"type": "op", "cmd": "<show><system><files></files></system></show>"}

return __proxy__["panos.call"](query)

def get_system_info():
    """
    Get the system information.

CLI Example:

.. code-block:: bash

salt '*' panos.get_system_info

"""
    query = {"type": "op", "cmd": "<show><system><info></info></system></show>"}

return __proxy__["panos.call"](query)

def get_system_services():
    """
    Show system services.

CLI Example:

.. code-block:: bash

salt '*' panos.get_system_services

"""
    query = {"type": "op", "cmd": "<show><system><services></services></system></show>"}

return __proxy__["panos.call"](query)

def get_system_state(mask=None):
    """
    Show the system state variables.

mask
        Filters by a subtree or a wildcard.

CLI Example:

.. code-block:: bash

salt '*' panos.get_system_state
        salt '*' panos.get_system_state mask=cfg.ha.config.enabled
        salt '*' panos.get_system_state mask=cfg.ha.*

"""
    if mask:
        query = {
            "type": "op",
            "cmd": (
                "<show><system><state><filter>{}</filter></state></system></show>".format(
                    mask
                )
            ),
        }
    else:
        query = {"type": "op", "cmd": "<show><system><state></state></system></show>"}

return __proxy__["panos.call"](query)

def get_uncommitted_changes():
    """
    Retrieve a list of all uncommitted changes on the device.
    Requires PANOS version 8.0.0 or greater.

CLI Example:

.. code-block:: bash

salt '*' panos.get_uncommitted_changes

"""
    _required_version = "8.0.0"
    if not __proxy__["panos.is_required_version"](_required_version):
        return (
            False,
            "The panos device requires version {} or greater for this command.".format(
                _required_version
            ),
        )

query = {
        "type": "op",
        "cmd": "<show><config><list><changes></changes></list></config></show>",
    }

return __proxy__["panos.call"](query)

def get_users_config():
    """
    Get the local administrative user account configuration.

CLI Example:

.. code-block:: bash

salt '*' panos.get_users_config

"""
    query = {"type": "config", "action": "get", "xpath": "/config/mgt-config/users"}

return __proxy__["panos.call"](query)

def get_vlans():
    """
    Show all VLAN information.

CLI Example:

.. code-block:: bash

salt '*' panos.get_vlans

"""
    query = {"type": "op", "cmd": "<show><vlan>all</vlan></show>"}

return __proxy__["panos.call"](query)

def get_xpath(xpath=""):
    """
    Retrieve a specified xpath from the candidate configuration.

xpath(str): The specified xpath in the candidate configuration.

CLI Example:

.. code-block:: bash

salt '*' panos.get_xpath /config/shared/service

"""
    query = {"type": "config", "action": "get", "xpath": xpath}

return __proxy__["panos.call"](query)

def get_zone(zone="", vsys="1"):
    """
    Get the candidate configuration for the specified zone.

zone(str): The name of the zone.

vsys(str): The string representation of the VSYS ID.

CLI Example:

.. code-block:: bash

salt '*' panos.get_zone trust
        salt '*' panos.get_zone trust 2

"""
    query = {
        "type": "config",
        "action": "get",
        "xpath": (
            "/config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys{}']/"
            "zone/entry[@name='{}']".format(vsys, zone)
        ),
    }

return __proxy__["panos.call"](query)

def get_zones(vsys="1"):
    """
    Get all the zones in the candidate configuration.

vsys(str): The string representation of the VSYS ID.

CLI Example:

.. code-block:: bash

salt '*' panos.get_zones
        salt '*' panos.get_zones 2

"""
    query = {
        "type": "config",
        "action": "get",
        "xpath": (
            "/config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys{}']/"
            "zone".format(vsys)
        ),
    }

return __proxy__["panos.call"](query)

def install_antivirus(
    version=None,
    latest=False,
    synch=False,
    skip_commit=False,
):
    """
    Install anti-virus packages.

Args:
        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.

CLI Example:

.. code-block:: bash

salt '*' panos.install_antivirus 8.0.0

"""
    if not version and latest is False:
        raise CommandExecutionError("Version option must not be none.")

if synch is True:
        s = "yes"
    else:
        s = "no"

if skip_commit is True:
        c = "yes"
    else:
        c = "no"

if latest is True:
        query = {
            "type": "op",
            "cmd": (
                "<request><anti-virus><upgrade><install>"
                "<commit>{}</commit><sync-to-peer>{}</sync-to-peer>"
                "<version>latest</version></install></upgrade></anti-virus></request>".format(
                    c, s
                )
            ),
        }
    else:
        query = {
            "type": "op",
            "cmd": (
                "<request><anti-virus><upgrade><install>"
                "<commit>{}</commit><sync-to-peer>{}</sync-to-peer>"
                "<version>{}</version></install></upgrade></anti-virus></request>".format(
                    c, s, version
                )
            ),
        }

return _get_job_results(query)

def install_license():
    """
    Install the license key(s).

CLI Example:

.. code-block:: bash

salt '*' panos.install_license

"""
    query = {
        "type": "op",
        "cmd": "<request><license><install></install></license></request>",
    }

return __proxy__["panos.call"](query)

def install_software(version=None):
    """
    Upgrade to a software package by version.

Args:
        version(str): The version of the PANOS file to install.

CLI Example:

.. code-block:: bash

salt '*' panos.install_license 8.0.0

"""
    if not version:
        raise CommandExecutionError("Version option must not be none.")

query = {
        "type": "op",
        "cmd": (
            "<request><system><software><install>"
            "<version>{}</version></install></software></system></request>".format(
                version
            )
        ),
    }

return _get_job_results(query)

def reboot():
    """
    Reboot a running system.

CLI Example:

.. code-block:: bash

salt '*' panos.reboot

"""
    query = {
        "type": "op",
        "cmd": "<request><restart><system></system></restart></request>",
    }

return __proxy__["panos.call"](query)

def refresh_fqdn_cache(force=False):
    """
    Force refreshes all FQDNs used in rules.

force
        Forces all fqdn refresh

CLI Example:

.. code-block:: bash

salt '*' panos.refresh_fqdn_cache
        salt '*' panos.refresh_fqdn_cache force=True

"""
    if not isinstance(force, bool):
        raise CommandExecutionError("Force option must be boolean.")

if force:
        query = {
            "type": "op",
            "cmd": "<request><system><fqdn><refresh><force>yes</force></refresh></fqdn></system></request>",
        }
    else:
        query = {
            "type": "op",
            "cmd": (
                "<request><system><fqdn><refresh></refresh></fqdn></system></request>"
            ),
        }

return __proxy__["panos.call"](query)

def remove_config_lock():
    """
    Release config lock previously held.

CLI Example:

.. code-block:: bash

salt '*' panos.remove_config_lock

"""
    query = {
        "type": "op",
        "cmd": "<request><config-lock><remove></remove></config-lock></request>",
    }

return __proxy__["panos.call"](query)

def 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.

CLI Example:

.. code-block:: bash

salt '*' panos.resolve_address foo.bar.com
        salt '*' panos.resolve_address foo.bar.com vsys=2

"""
    _required_version = "7.0.0"
    if not __proxy__["panos.is_required_version"](_required_version):
        return (
            False,
            "The panos device requires version {} or greater for this command.".format(
                _required_version
            ),
        )

if not address:
        raise CommandExecutionError("FQDN to resolve must be provided as address.")

if not vsys:
        query = {
            "type": "op",
            "cmd": "<request><resolve><address>{}</address></resolve></request>".format(
                address
            ),
        }
    else:
        query = {
            "type": "op",
            "cmd": (
                "<request><resolve><vsys>{}</vsys><address>{}</address></resolve>"
                "</request>".format(vsys, address)
            ),
        }

return __proxy__["panos.call"](query)

def save_device_config(filename=None):
    """
    Save device configuration to a named file.

filename
        The filename to save the configuration to.

CLI Example:

.. code-block:: bash

salt '*' panos.save_device_config foo.xml

"""
    if not filename:
        raise CommandExecutionError("Filename must not be empty.")

query = {
        "type": "op",
        "cmd": "<save><config><to>{}</to></config></save>".format(filename),
    }

return __proxy__["panos.call"](query)

def save_device_state():
    """
    Save files needed to restore device to local disk.

CLI Example:

.. code-block:: bash

salt '*' panos.save_device_state

"""
    query = {"type": "op", "cmd": "<save><device-state></device-state></save>"}

return __proxy__["panos.call"](query)

def 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.

CLI Example:

Args:
        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.

.. code-block:: bash

salt '*' panos.set_authentication_profile foo
        salt '*' panos.set_authentication_profile foo deploy=True

"""

if not profile:
        raise CommandExecutionError("Profile name option must not be none.")

ret = {}

query = {
        "type": "config",
        "action": "set",
        "xpath": (
            "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/"
            "authentication-profile"
        ),
        "element": "<authentication-profile>{}</authentication-profile>".format(
            profile
        ),
    }

ret.update(__proxy__["panos.call"](query))

if deploy is True:
        ret.update(commit())

return ret

def set_hostname(hostname=None, deploy=False):
    """
    Set the hostname of the Palo Alto proxy minion. A commit will be required before this is processed.

CLI Example:

Args:
        hostname (str): The hostname to set

deploy (bool): If true then commit the full candidate configuration, if false only set pending change.

.. code-block:: bash

salt '*' panos.set_hostname newhostname
        salt '*' panos.set_hostname newhostname deploy=True

"""

if not hostname:
        raise CommandExecutionError("Hostname option must not be none.")

ret = {}

query = {
        "type": "config",
        "action": "set",
        "xpath": (
            "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system"
        ),
        "element": "<hostname>{}</hostname>".format(hostname),
    }

ret.update(__proxy__["panos.call"](query))

if deploy is True:
        ret.update(commit())

return ret

def set_management_icmp(enabled=True, deploy=False):
    """
    Enables or disables the ICMP management service on the device.

CLI Example:

Args:
        enabled (bool): If true the service will be enabled. If false the service will be disabled.

deploy (bool): If true then commit the full candidate configuration, if false only set pending change.

.. code-block:: bash

salt '*' panos.set_management_icmp
        salt '*' panos.set_management_icmp enabled=False deploy=True

"""

if enabled is True:
        value = "no"
    elif enabled is False:
        value = "yes"
    else:
        raise CommandExecutionError(
            "Invalid option provided for service enabled option."
        )

ret = {}

query = {
        "type": "config",
        "action": "set",
        "xpath": "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/service",
        "element": "<disable-icmp>{}</disable-icmp>".format(value),
    }

ret.update(__proxy__["panos.call"](query))

if deploy is True:
        ret.update(commit())

return ret

def set_management_http(enabled=True, deploy=False):
    """
    Enables or disables the HTTP management service on the device.

CLI Example:

Args:
        enabled (bool): If true the service will be enabled. If false the service will be disabled.

deploy (bool): If true then commit the full candidate configuration, if false only set pending change.

.. code-block:: bash

salt '*' panos.set_management_http
        salt '*' panos.set_management_http enabled=False deploy=True

"""

ret = {}

query = {
        "type": "config",
        "action": "set",
        "xpath": "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/service",
        "element": "<disable-http>{}</disable-http>".format(value),
    }

ret.update(__proxy__["panos.call"](query))

if deploy is True:
        ret.update(commit())

return ret

def set_management_https(enabled=True, deploy=False):
    """
    Enables or disables the HTTPS management service on the device.

CLI Example:

Args:
        enabled (bool): If true the service will be enabled. If false the service will be disabled.

deploy (bool): If true then commit the full candidate configuration, if false only set pending change.

.. code-block:: bash

salt '*' panos.set_management_https
        salt '*' panos.set_management_https enabled=False deploy=True

"""

ret = {}

ret.update(__proxy__["panos.call"](query))

if deploy is True:
        ret.update(commit())

return ret

def set_management_ocsp(enabled=True, deploy=False):
    """
    Enables or disables the HTTP OCSP management service on the device.

CLI Example:

Args:
        enabled (bool): If true the service will be enabled. If false the service will be disabled.

deploy (bool): If true then commit the full candidate configuration, if false only set pending change.

.. code-block:: bash

salt '*' panos.set_management_ocsp
        salt '*' panos.set_management_ocsp enabled=False deploy=True

"""

ret = {}

ret.update(__proxy__["panos.call"](query))

if deploy is True:
        ret.update(commit())

return ret

def set_management_snmp(enabled=True, deploy=False):
    """
    Enables or disables the SNMP management service on the device.

CLI Example:

Args:
        enabled (bool): If true the service will be enabled. If false the service will be disabled.

deploy (bool): If true then commit the full candidate configuration, if false only set pending change.

.. code-block:: bash

salt '*' panos.set_management_snmp
        salt '*' panos.set_management_snmp enabled=False deploy=True

"""

ret = {}

query = {
        "type": "config",
        "action": "set",
        "xpath": "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/service",
        "element": "<disable-snmp>{}</disable-snmp>".format(value),
    }

ret.update(__proxy__["panos.call"](query))

if deploy is True:
        ret.update(commit())

return ret

def set_management_ssh(enabled=True, deploy=False):
    """
    Enables or disables the SSH management service on the device.

CLI Example:

Args:
        enabled (bool): If true the service will be enabled. If false the service will be disabled.

deploy (bool): If true then commit the full candidate configuration, if false only set pending change.

.. code-block:: bash

salt '*' panos.set_management_ssh
        salt '*' panos.set_management_ssh enabled=False deploy=True

"""

ret = {}

ret.update(__proxy__["panos.call"](query))

if deploy is True:
        ret.update(commit())

return ret

def set_management_telnet(enabled=True, deploy=False):
    """
    Enables or disables the Telnet management service on the device.

CLI Example:

Args:
        enabled (bool): If true the service will be enabled. If false the service will be disabled.

deploy (bool): If true then commit the full candidate configuration, if false only set pending change.

.. code-block:: bash

salt '*' panos.set_management_telnet
        salt '*' panos.set_management_telnet enabled=False deploy=True

"""

ret = {}

query = {
        "type": "config",
        "action": "set",
        "xpath": "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/service",
        "element": "<disable-telnet>{}</disable-telnet>".format(value),
    }

ret.update(__proxy__["panos.call"](query))

if deploy is True:
        ret.update(commit())

return ret

def 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.

CLI Example:

Args:
        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.

deploy (bool): If true then commit the full candidate configuration, if false only set pending change.

.. code-block:: bash

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

"""
    ret = {}

if target not in ["primary", "secondary", "both"]:
        raise salt.exceptions.CommandExecutionError(
            "Target option must be primary, secondary, or both."
        )

if authentication_type not in ["symmetric", "autokey", "none"]:
        raise salt.exceptions.CommandExecutionError(
            "Type option must be symmetric, autokey, or both."
        )

if authentication_type == "symmetric" and not authentication_key:
        raise salt.exceptions.CommandExecutionError(
            "When using symmetric authentication, authentication_key must be provided."
        )

if authentication_type == "symmetric" and not key_id:
        raise salt.exceptions.CommandExecutionError(
            "When using symmetric authentication, key_id must be provided."
        )

if authentication_type == "symmetric" and algorithm not in ["md5", "sha1"]:
        raise salt.exceptions.CommandExecutionError(
            "When using symmetric authentication, algorithm must be md5 or sha1."
        )

if authentication_type == "symmetric":
        if target == "primary" or target == "both":
            query = {
                "type": "config",
                "action": "set",
                "xpath": (
                    "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/ntp-servers/"
                    "primary-ntp-server/authentication-type"
                ),
                "element": (
                    "<symmetric-key><algorithm><{0}><authentication-key>{1}</authentication-key></{0}>"
                    "</algorithm><key-id>{2}</key-id></symmetric-key>".format(
                        algorithm, authentication_key, key_id
                    )
                ),
            }
            ret.update({"primary_server": __proxy__["panos.call"](query)})

if target == "secondary" or target == "both":
            query = {
                "type": "config",
                "action": "set",
                "xpath": (
                    "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/ntp-servers/"
                    "secondary-ntp-server/authentication-type"
                ),
                "element": (
                    "<symmetric-key><algorithm><{0}><authentication-key>{1}</authentication-key></{0}>"
                    "</algorithm><key-id>{2}</key-id></symmetric-key>".format(
                        algorithm, authentication_key, key_id
                    )
                ),
            }
            ret.update({"secondary_server": __proxy__["panos.call"](query)})
    elif authentication_type == "autokey":
        if target == "primary" or target == "both":
            query = {
                "type": "config",
                "action": "set",
                "xpath": (
                    "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/ntp-servers/"
                    "primary-ntp-server/authentication-type"
                ),
                "element": "<autokey/>",
            }
            ret.update({"primary_server": __proxy__["panos.call"](query)})

if target == "secondary" or target == "both":
            query = {
                "type": "config",
                "action": "set",
                "xpath": (
                    "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/ntp-servers/"
                    "secondary-ntp-server/authentication-type"
                ),
                "element": "<autokey/>",
            }
            ret.update({"secondary_server": __proxy__["panos.call"](query)})
    elif authentication_type == "none":
        if target == "primary" or target == "both":
            query = {
                "type": "config",
                "action": "set",
                "xpath": (
                    "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/ntp-servers/"
                    "primary-ntp-server/authentication-type"
                ),
                "element": "<none/>",
            }
            ret.update({"primary_server": __proxy__["panos.call"](query)})

if deploy is True:
        ret.update(commit())

return ret

def 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.

CLI Example:

Args:
        primary_server(str): The primary NTP server IP address or FQDN.

secondary_server(str): The secondary NTP server IP address or FQDN.

deploy (bool): If true then commit the full candidate configuration, if false only set pending change.

.. code-block:: bash

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

"""
    ret = {}

if primary_server:
        query = {
            "type": "config",
            "action": "set",
            "xpath": (
                "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/ntp-servers/"
                "primary-ntp-server"
            ),
            "element": "<ntp-server-address>{}</ntp-server-address>".format(
                primary_server
            ),
        }
        ret.update({"primary_server": __proxy__["panos.call"](query)})

if secondary_server:
        query = {
            "type": "config",
            "action": "set",
            "xpath": (
                "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/ntp-servers/"
                "secondary-ntp-server"
            ),
            "element": "<ntp-server-address>{}</ntp-server-address>".format(
                secondary_server
            ),
        }
        ret.update({"secondary_server": __proxy__["panos.call"](query)})

if deploy is True:
        ret.update(commit())

return ret

def set_permitted_ip(address=None, deploy=False):
    """
    Add an IPv4 address or network to the permitted IP list.

CLI Example:

Args:
        address (str): The IPv4 address or network to allow access to add to the Palo Alto device.

deploy (bool): If true then commit the full candidate configuration, if false only set pending change.

.. code-block:: bash

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

"""

if not address:
        raise CommandExecutionError("Address option must not be empty.")

ret = {}

query = {
        "type": "config",
        "action": "set",
        "xpath": "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/permitted-ip",
        "element": "<entry name='{}'></entry>".format(address),
    }

ret.update(__proxy__["panos.call"](query))

if deploy is True:
        ret.update(commit())

return ret

def set_timezone(tz=None, deploy=False):
    """
    Set the timezone of the Palo Alto proxy minion. A commit will be required before this is processed.

CLI Example:

Args:
        tz (str): The name of the timezone to set.

deploy (bool): If true then commit the full candidate configuration, if false only set pending change.

.. code-block:: bash

salt '*' panos.set_timezone UTC
        salt '*' panos.set_timezone UTC deploy=True

"""

if not tz:
        raise CommandExecutionError("Timezone name option must not be none.")

ret = {}

query = {
        "type": "config",
        "action": "set",
        "xpath": "/config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/timezone",
        "element": "<timezone>{}</timezone>".format(tz),
    }

ret.update(__proxy__["panos.call"](query))

if deploy is True:
        ret.update(commit())

return ret

def shutdown():
    """
    Shutdown a running system.

CLI Example:

.. code-block:: bash

salt '*' panos.shutdown

"""
    query = {
        "type": "op",
        "cmd": "<request><shutdown><system></system></shutdown></request>",
    }

return __proxy__["panos.call"](query)

def 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.

CLI Example:

.. code-block:: bash

salt '*' panos.test_fib_route 4.2.2.2
        salt '*' panos.test_fib_route 4.2.2.2 my-vr

"""

xpath = "<test><routing><fib-lookup>"

if ip:
        xpath += "<ip>{}</ip>".format(ip)

if vr:
        xpath += "<virtual-router>{}</virtual-router>".format(vr)

xpath += "</fib-lookup></routing></test>"

query = {"type": "op", "cmd": xpath}

return __proxy__["panos.call"](query)

def 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.

CLI Example:

.. code-block:: bash

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

"""

xpath = "<test><security-policy-match>"

if sourcezone:
        xpath += "<from>{}</from>".format(sourcezone)

if destinationzone:
        xpath += "<to>{}</to>".format(destinationzone)

if source:
        xpath += "<source>{}</source>".format(source)

if destination:
        xpath += "<destination>{}</destination>".format(destination)

if protocol:
        xpath += "<protocol>{}</protocol>".format(protocol)

if port:
        xpath += "<destination-port>{}</destination-port>".format(port)

if application:
        xpath += "<application>{}</application>".format(application)

if category:
        xpath += "<category>{}</category>".format(category)

if allrules:
        xpath += "<show-all>yes</show-all>"

xpath += "</security-policy-match></test>"

query = {"type": "op", "vsys": "vsys{}".format(vsys), "cmd": xpath}

return __proxy__["panos.call"](query)

def unlock_admin(username=None):
    """
    Unlocks a locked administrator account.

username
        Username of the administrator.

CLI Example:

.. code-block:: bash

salt '*' panos.unlock_admin username=bob

"""
    if not username:
        raise CommandExecutionError("Username option must not be none.")

query = {
        "type": "op",
        "cmd": (
            "<set><management-server><unlock><admin>{}</admin></unlock></management-server>"
            "</set>".format(username)
        ),
    }

return __proxy__["panos.call"](query)