Current File : //usr/lib/python2.7/site-packages/salt/modules/panos.pyc
�
���^c @@ s� d Z d d l m Z m Z m Z d d l Z d d l Z d d l m Z d d l Z
d d l Z
e j e
� Z d Z d � Z d d � Z d � Z d � Z d
� Z d � Z d � Z d d
� Z d d � Z d � Z d e d � Z d e d � Z d d � Z d d d � Z d d d � Z d � Z! d � Z" d � Z# d � Z$ d � Z% d � Z& d � Z' d � Z( d � Z) d � Z* d � Z+ d! � Z, d" � Z- d# � Z. d$ � Z/ d% � Z0 d& � Z1 d' d( � Z2 d' d) � Z3 d d* � Z4 d' d+ � Z5 d, � Z6 d- � Z7 d. � Z8 d/ � Z9 d0 � Z: d1 � Z; d2 � Z< d3 � Z= d4 � Z> d5 � Z? d6 � Z@ d7 � ZA d8 � ZB d9 � ZC d: � ZD d; � ZE d d< � ZF d d d= � ZG d d d> � ZH d d d? � ZI d@ � ZJ dA � ZK dB � ZL dC � ZM dD � ZN dE � ZO dF � ZP d dG � ZQ dH � ZR dI � ZS dJ � ZT dK dL � ZU dK d dM � ZV d dN � ZW d e e e dO � ZX dP � ZY d dQ � ZZ dR � Z[ e dS � Z\ dT � Z] d d dU � Z^ d dV � Z_ dW � Z` d e dX � Za d e dY � Zb ec e dZ � Zd ec e d[ � Ze ec e d\ � Zf ec e d] � Zg ec e d^ � Zh ec e d_ � Zi ec e d` � Zj d d d d d e da � Zk d d e db � Zl d e dc � Zm d e dd � Zn de � Zo d df dg � Zp d d d d d d d d d e dh �
Zq d di � Zr d S(j u�
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.
i ( t absolute_importt print_functiont unicode_literalsN( t CommandExecutionErroru panosc C@ sL y. t j j j � r- t d d d k r- t SWn t k
rA n Xt d f S( u0
Will load for the panos proxy minions.
u proxyu proxytypeu panosuF The panos execution module can only be loaded for panos proxy minions.( t saltt utilst platformt is_proxyt __opts__t __virtualname__t KeyErrort False( ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt __virtual__. s
c C@ s� | s t d � � n t d | � } d | k r� d | d k r� | d d } x/ t | � d d d d k r� t j d � qR Wt | � S| Sd S( u�
Executes a query that requires a job for completion. This function will wait for the job to complete
and return the results.
u! Query parameters cannot be empty.u
panos.callu resultu jobu statusu FINi N( R t __proxy__t get_jobt timet sleep( t queryt responset jid( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt _get_job_results< s !
c C@ s" i d d 6d d 6} t d | � S( u�
Prevent other users from changing configuration until the lock is released.
CLI Example:
.. code-block:: bash
salt '*' panos.add_config_lock
u opu typeu9 <request><config-lock><add></add></config-lock></request>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt add_config_lockR s c C@ s" i d d 6d d 6} t d | � S( u�
Get anti-virus information from PaloAlto Networks server
CLI Example:
.. code-block:: bash
salt '*' panos.check_antivirus
u opu typeuN <request><anti-virus><upgrade><check></check></upgrade></anti-virus></request>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt check_antivirusb s c C@ s" i d d 6d d 6} t d | � S( u�
Get software information from PaloAlto Networks server.
CLI Example:
.. code-block:: bash
salt '*' panos.check_software
u opu typeuH <request><system><software><check></check></software></system></request>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt check_softwarer s c C@ s" i d d 6d d 6} t d | � S( uy
Clear all commit tasks.
CLI Example:
.. code-block:: bash
salt '*' panos.clear_commit_tasks
u opu typeu< <request><clear-commit-tasks></clear-commit-tasks></request>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt clear_commit_tasks� s c C@ s i d d 6d d 6} t | � S( u�
Commits the candidate configuration to the running configuration.
CLI Example:
.. code-block:: bash
salt '*' panos.commit
u commitu typeu <commit></commit>u cmd( R ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt commit� s c C@ sd d } t d | � s) t d j | � f S| s9 t d f Si d d 6d j | � d 6} t d | � S(
u
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
u 7.0.0u panos.is_required_versionuB The panos device requires version {0} or greater for this command.u You must specify a key_name.u opu typeus <request><license><deactivate><key><features><member>{0}</member></features></key></deactivate></license></request>u cmdu
panos.call( R
R t format( t key_namet _required_versionR ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt deactivate_license� s
c C@ s; | s t d f Si d d 6d j | � d 6} t d | � S( u�
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
u You must specify a key_name.u opu typeu2 <delete><license><key>{0}</key></license></delete>u cmdu
panos.call( R R R
( R R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt delete_license� s
c C@ s i d d 6d d 6} t | � S( u�
Download the most recent anti-virus package.
CLI Example:
.. code-block:: bash
salt '*' panos.download_antivirus
u opu typeue <request><anti-virus><upgrade><download><latest></latest></download></upgrade></anti-virus></request>u cmd( R ( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt download_antivirus� s
c C@ s� | s t d � � n t | t � s3 t d � � n | t k r_ i d d 6d j | � d 6} n i d d 6d j | � d 6} t | � S( uz
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
u! Filename option must not be none.u Synch option must be boolean..u opu typeu^ <request><system><software><download><file>{0}</file></download></software></system></request>u cmdu~ <request><system><software><download><sync-to-peer>yes</sync-to-peer><file>{0}</file></download></software></system></request>( R t
isinstancet boolt TrueR R ( t filenamet synchR ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt download_software_file� s
c C@ s� | s t d � � n t | t � s3 t d � � n | t k r_ i d d 6d j | � d 6} n i d d 6d j | � d 6} t | � S( un
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
u Version option must not be none.u Synch option must be boolean..u opu typeud <request><system><software><download><version>{0}</version></download></software></system></request>u cmdu� <request><system><software><download><sync-to-peer>yes</sync-to-peer><version>{0}</version></download></software></system></request>( R R R! R" R R ( t versionR$ R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt download_software_version s
c C@ sH | s i d d 6d d 6} n i d d 6d j | � d 6} t d | � S( u
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
u opu typeu5 <request><license><fetch></fetch></license></request>u cmduO <request><license><fetch><auth-code>{0}</auth-code></fetch></license></request>u
panos.call( R R
( t auth_codeR ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt
fetch_license, s
u 1c C@ s5 i d d 6d d 6d j | | � d 6} t d | � S( u�
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
u configu typeu getu actionuk /config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys{0}']/address/entry[@name='{1}']u xpathu
panos.call( R R
( t addresst vsysR ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_addressD s
c C@ s5 i d d 6d d 6d j | | � d 6} t d | � S( u�
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
u configu typeu getu actionuq /config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys{0}']/address-group/entry[@name='{1}']u xpathu
panos.call( R R
( t addressgroupR+ R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_address_group] s
c C@ s" i d d 6d d 6} t d | � S( u|
Show active administrators.
CLI Example:
.. code-block:: bash
salt '*' panos.get_admins_active
u opu typeu <show><admins></admins></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_admins_activev s c C@ s" i d d 6d d 6} t d | � S( uv
Show all administrators.
CLI Example:
.. code-block:: bash
salt '*' panos.get_admins_all
u opu typeu) <show><admins><all></all></admins></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_admins_all� s c C@ s" i d d 6d d 6} t d | � S( u�
Show information about available anti-virus packages.
CLI Example:
.. code-block:: bash
salt '*' panos.get_antivirus_info
u opu typeuL <request><anti-virus><upgrade><info></info></upgrade></anti-virus></request>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_antivirus_info� s c C@ s" i d d 6d d 6} t d | � S( ul
Show ARP information.
CLI Example:
.. code-block:: bash
salt '*' panos.get_arp
u opu typeu- <show><arp><entry name = 'all'/></arp></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_arp� s c C@ s" i d d 6d d 6} t d | � S( u�
Show timeout information for this administrative session.
CLI Example:
.. code-block:: bash
salt '*' panos.get_cli_idle_timeout
u opu typeu5 <show><cli><idle-timeout></idle-timeout></cli></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_cli_idle_timeout� s c C@ s" i d d 6d d 6} t d | � S( u�
Show cli administrative permissions.
CLI Example:
.. code-block:: bash
salt '*' panos.get_cli_permissions
u opu typeu3 <show><cli><permissions></permissions></cli></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_cli_permissions� s c C@ s" i d d 6d d 6} t d | � S( u�
Report filesystem disk space usage.
CLI Example:
.. code-block:: bash
salt '*' panos.get_disk_usage
u opu typeu7 <show><system><disk-space></disk-space></system></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_disk_usage� s c C@ s) i d d 6d d 6d d 6} t d | � S( u�
Get the DNS server configuration from the candidate configuration.
CLI Example:
.. code-block:: bash
salt '*' panos.get_dns_server_config
u configu typeu getu actionu\ /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/dns-setting/serversu xpathu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_dns_server_config� s
c C@ s) i d d 6d d 6d d 6} t d | � S( u�
Get the domain name configuration from the candidate configuration.
CLI Example:
.. code-block:: bash
salt '*' panos.get_domain_config
u configu typeu getu actionuO /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/domainu xpathu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_domain_config� s
c C@ s" i d d 6d d 6} t d | � S( uz
Show the DoS block-ip table.
CLI Example:
.. code-block:: bash
salt '*' panos.get_dos_blocks
u opu typeu; <show><dos-block-table><all></all></dos-block-table></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_dos_blocks
s c C@ s" i d d 6d d 6} t d | � S( u�
Print FQDNs used in rules and their IPs.
CLI Example:
.. code-block:: bash
salt '*' panos.get_fqdn_cache
u opu typeu> <request><system><fqdn><show></show></fqdn></system></request>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_fqdn_cache s c C@ s) i d d 6d d 6d d 6} t d | � S( u�
Get the high availability configuration.
CLI Example:
.. code-block:: bash
salt '*' panos.get_ha_config
u configu typeu getu actionuS /config/devices/entry[@name='localhost.localdomain']/deviceconfig/high-availabilityu xpathu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt
get_ha_config* s
c C@ s" i d d 6d d 6} t d | � S( u�
Show high-availability link-monitoring state.
CLI Example:
.. code-block:: bash
salt '*' panos.get_ha_link
u opu typeuW <show><high-availability><link-monitoring></link-monitoring></high-availability></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_ha_link< s
c C@ s" i d d 6d d 6} t d | � S( u�
Show high-availability path-monitoring state.
CLI Example:
.. code-block:: bash
salt '*' panos.get_ha_path
u opu typeuW <show><high-availability><path-monitoring></path-monitoring></high-availability></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_ha_pathM s
c C@ s" i d d 6d d 6} t d | � S( u�
Show high-availability state information.
CLI Example:
.. code-block:: bash
salt '*' panos.get_ha_state
u opu typeuC <show><high-availability><state></state></high-availability></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_ha_state^ s
c C@ s" i d d 6d d 6} t d | � S( u�
Show high-availability transition statistic information.
CLI Example:
.. code-block:: bash
salt '*' panos.get_ha_transitions
u opu typeuO <show><high-availability><transitions></transitions></high-availability></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_ha_transitionsp s
c C@ s) i d d 6d d 6d d 6} t d | � S( u{
Get the hostname of the device.
CLI Example:
.. code-block:: bash
salt '*' panos.get_hostname
u configu typeu getu actionuQ /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/hostnameu xpathu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_hostname� s
u allc C@ s+ i d d 6d j | � d 6} t d | � S( u=
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
u opu typeu: <show><counter><interface>{0}</interface></counter></show>u cmdu
panos.call( R R
( t nameR ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_interface_counters� s
c C@ s+ i d d 6d j | � d 6} t d | � S( u
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
u opu typeu' <show><interface>{0}</interface></show>u cmdu
panos.call( R R
( R@ R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_interfaces� s
c C@ s@ | s t d � � n i d d 6d j | � d 6} t d | � S( u�
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
u ID option must not be none.u opu typeu& <show><jobs><id>{0}</id></jobs></show>u cmdu
panos.call( R R R
( R R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyR � s c C@ s� | j � d k r) i d d 6d d 6} n^ | j � d k rR i d d 6d d 6} n5 | j � d k r{ i d d 6d d 6} n t d
� � t d | � S( u�
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
u allu opu typeu% <show><jobs><all></all></jobs></show>u cmdu pendingu- <show><jobs><pending></pending></jobs></show>u processedu1 <show><jobs><processed></processed></jobs></show>u7 The state parameter must be all, pending, or processed.u
panos.call( t lowerR R
( t stateR ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_jobs� s c C@ s" i d d 6d d 6} t d | � S( uh
Show LACP state.
CLI Example:
.. code-block:: bash
salt '*' panos.get_lacp
u opu typeuF <show><lacp><aggregate-ethernet>all</aggregate-ethernet></lacp></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_lacp� s c C@ s" i d d 6d d 6} t d | � S( u�
Show information about owned license(s).
CLI Example:
.. code-block:: bash
salt '*' panos.get_license_info
u opu typeu3 <request><license><info></info></license></request>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_license_info s c C@ s" i d d 6d d 6} t d | � S( u�
Show license token files for manual license deactivation.
CLI Example:
.. code-block:: bash
salt '*' panos.get_license_tokens
u opu typeu8 <show><license-token-files></license-token-files></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_license_tokens s c C@ s" i d d 6d d 6} t d | � S( u
Show lldp config for interfaces.
CLI Example:
.. code-block:: bash
salt '*' panos.get_lldp_config
u opu typeu. <show><lldp><config>all</config></lldp></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_lldp_config! s c C@ s" i d d 6d d 6} t d | � S( u�
Show lldp counters for interfaces.
CLI Example:
.. code-block:: bash
salt '*' panos.get_lldp_counters
u opu typeu2 <show><lldp><counters>all</counters></lldp></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_lldp_counters1 s c C@ s" i d d 6d d 6} t d | � S( u�
Show lldp local info for interfaces.
CLI Example:
.. code-block:: bash
salt '*' panos.get_lldp_local
u opu typeu, <show><lldp><local>all</local></lldp></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_lldp_localA s c C@ s" i d d 6d d 6} t d | � S( u�
Show lldp neighbors info for interfaces.
CLI Example:
.. code-block:: bash
salt '*' panos.get_lldp_neighbors
u opu typeu4 <show><lldp><neighbors>all</neighbors></lldp></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_lldp_neighborsQ s c C@ s� t � } g } d | d k r# | St | d d d t � ro xK | d d d D] } | j | d � qQ Wn | j | d d d d � | S( u�
Show all local administrator accounts.
CLI Example:
.. code-block:: bash
salt '*' panos.get_local_admins
u usersu resultu entryu name( t get_users_configR t listt append( t
admin_listR t entry( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_local_adminsa s c C@ s" i d d 6d d 6} t d | � S( uw
Report the logdb quotas.
CLI Example:
.. code-block:: bash
salt '*' panos.get_logdb_quota
u opu typeu9 <show><system><logdb-quota></logdb-quota></system></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_logdb_quota{ s c C@ s" i d d 6d d 6} t d | � S( u|
Get the master key properties.
CLI Example:
.. code-block:: bash
salt '*' panos.get_master_key
u opu typeuK <show><system><masterkey-properties></masterkey-properties></system></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_master_key� s c C@ s) i d d 6d d 6d d 6} t d | � S( u�
Get the NTP configuration from the candidate configuration.
CLI Example:
.. code-block:: bash
salt '*' panos.get_ntp_config
u configu typeu getu actionuT /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/ntp-serversu xpathu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_ntp_config� s
c C@ s" i d d 6d d 6} t d | � S( u�
Get list of configured NTP servers.
CLI Example:
.. code-block:: bash
salt '*' panos.get_ntp_servers
u opu typeu <show><ntp></ntp></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_ntp_servers� s c C@ s" i d d 6d d 6} t d | � S( u�
Show device operational mode setting.
CLI Example:
.. code-block:: bash
salt '*' panos.get_operational_mode
u opu typeu2 <show><operational-mode></operational-mode></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_operational_mode� s c C@ s" i d d 6d d 6} t d | � S( u�
Show panorama connection status.
CLI Example:
.. code-block:: bash
salt '*' panos.get_panorama_status
u opu typeu0 <show><panorama-status></panorama-status></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_panorama_status� s c C@ s) i d d 6d d 6d d 6} t d | � S( u�
Get the IP addresses that are permitted to establish management connections to the device.
CLI Example:
.. code-block:: bash
salt '*' panos.get_permitted_ips
u configu typeu getu actionuU /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/permitted-ipu xpathu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_permitted_ips� s
c C@ s) i d d 6d d 6d d 6} t d | � S( u�
Get the platform model information and limitations.
CLI Example:
.. code-block:: bash
salt '*' panos.get_platform
u configu typeu getu actionu= /config/devices/entry[@name='localhost.localdomain']/platformu xpathu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_platform� s
c C@ s2 i d d 6d d 6d j | � d 6} t d | � S( u=
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
u configu typeu getu actionu1 /config/predefined/application/entry[@name='{0}']u xpathu
panos.call( R R
( t applicationR ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_predefined_application s
c C@ s5 i d d 6d d 6d j | | � d 6} t d | � S( uG
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
u configu typeu getu actionu{ /config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys{0}']/rulebase/security/rules/entry[@name='{1}']u xpathu
panos.call( R R
( t rulenameR+ R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_security_rule s
c C@ s5 i d d 6d d 6d j | | � d 6} t d | � S( u�
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
u configu typeu getu actionuk /config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys{0}']/service/entry[@name='{1}']u xpathu
panos.call( R R
( t serviceR+ R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_service. s
c C@ s5 i d d 6d d 6d j | | � d 6} t d | � S( u�
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
u configu typeu getu actionuq /config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys{0}']/service-group/entry[@name='{1}']u xpathu
panos.call( R R
( t servicegroupR+ R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_service_groupG s
c C@ s" i d d 6d d 6} t d | � S( u
Show device session statistics.
CLI Example:
.. code-block:: bash
salt '*' panos.get_session_info
u opu typeu- <show><session><info></info></session></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_session_info` s
c C@ s) i d d 6d d 6d d 6} t d | � S( u�
Get the SNMP configuration from the device.
CLI Example:
.. code-block:: bash
salt '*' panos.get_snmp_config
u configu typeu getu actionuU /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/snmp-settingu xpathu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_snmp_configq s
c C@ s" i d d 6d d 6} t d | � S( u�
Show information about available software packages.
CLI Example:
.. code-block:: bash
salt '*' panos.get_software_info
u opu typeuF <request><system><software><info></info></software></system></request>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_software_info� s c C@ s" i d d 6d d 6} t d | � S( u}
Get the system date/time.
CLI Example:
.. code-block:: bash
salt '*' panos.get_system_date_time
u opu typeu <show><clock></clock></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_system_date_time� s c C@ s" i d d 6d d 6} t d | � S( u�
List important files in the system.
CLI Example:
.. code-block:: bash
salt '*' panos.get_system_files
u opu typeu- <show><system><files></files></system></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_system_files� s c C@ s" i d d 6d d 6} t d | � S( uz
Get the system information.
CLI Example:
.. code-block:: bash
salt '*' panos.get_system_info
u opu typeu+ <show><system><info></info></system></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_system_info� s c C@ s" i d d 6d d 6} t d | � S( ux
Show system services.
CLI Example:
.. code-block:: bash
salt '*' panos.get_system_services
u opu typeu3 <show><system><services></services></system></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_system_services� s c C@ sH | r& i d d 6d j | � d 6} n i d d 6d d 6} t d | � S( u/
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.*
u opu typeuA <show><system><state><filter>{0}</filter></state></system></show>u cmdu- <show><system><state></state></system></show>u
panos.call( R R
( t maskR ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_system_state� s
c C@ sK d } t d | � s) t d j | � f Si d d 6d d 6} t d | � S( u�
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
u 8.0.0u panos.is_required_versionuB The panos device requires version {0} or greater for this command.u opu typeu> <show><config><list><changes></changes></list></config></show>u cmdu
panos.call( R
R R ( R R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_uncommitted_changes� s
c C@ s) i d d 6d d 6d d 6} t d | � S( u�
Get the local administrative user account configuration.
CLI Example:
.. code-block:: bash
salt '*' panos.get_users_config
u configu typeu getu actionu /config/mgt-config/usersu xpathu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyRM s
c C@ s" i d d 6d d 6} t d | � S( us
Show all VLAN information.
CLI Example:
.. code-block:: bash
salt '*' panos.get_vlans
u opu typeu <show><vlan>all</vlan></show>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_vlans s u c C@ s) i d d 6d d 6| d 6} t d | � S( u�
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
u configu typeu getu actionu xpathu
panos.call( R
( t xpathR ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_xpath$ s
c C@ s5 i d d 6d d 6d j | | � d 6} t d | � S( u
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
u configu typeu getu actionuh /config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys{0}']/zone/entry[@name='{1}']u xpathu
panos.call( R R
( t zoneR+ R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_zone8 s
c C@ s2 i d d 6d d 6d j | � d 6} t d | � S( u�
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
u configu typeu getu actionuU /config/devices/entry[@name='localhost.localdomain']/vsys/entry[@name='vsys{0}']/zoneu xpathu
panos.call( R R
( R+ R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt get_zonesP s
c C@ s� | r" | t k r" t d � � n | t k r7 d } n d } | t k rR d } n d } | t k r� i d d 6d j | | � d 6} n# i d d 6d j | | | � d 6} t | � S( u
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
u Version option must not be none.u yesu nou opu typeu� <request><anti-virus><upgrade><install><commit>{0}</commit><sync-to-peer>{1}</sync-to-peer><version>latest</version></install></upgrade></anti-virus></request>u cmdu� <request><anti-virus><upgrade><install><commit>{0}</commit><sync-to-peer>{1}</sync-to-peer><version>{2}</version></install></upgrade></anti-virus></request>( R R R" R R ( R& t latestR$ t skip_committ st cR ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt install_antivirusf s
c C@ s" i d d 6d d 6} t d | � S( uz
Install the license key(s).
CLI Example:
.. code-block:: bash
salt '*' panos.install_license
u opu typeu9 <request><license><install></install></license></request>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt install_license� s c C@ s< | s t d � � n i d d 6d j | � d 6} t | � S( u�
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
u Version option must not be none.u opu typeub <request><system><software><install><version>{0}</version></install></software></system></request>u cmd( R R R ( R& R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt install_software� s
c C@ s" i d d 6d d 6} t d | � S( un
Reboot a running system.
CLI Example:
.. code-block:: bash
salt '*' panos.reboot
u opu typeu7 <request><restart><system></system></restart></request>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt reboot� s c C@ s] t | t � s t d � � n | r; i d d 6d d 6} n i d d 6d d 6} t d | � S( u�
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
u Force option must be boolean.u opu typeuV <request><system><fqdn><refresh><force>yes</force></refresh></fqdn></system></request>u cmduD <request><system><fqdn><refresh></refresh></fqdn></system></request>u
panos.call( R R! R R
( t forceR ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt refresh_fqdn_cache� s
c C@ s" i d d 6d d 6} t d | � S( u�
Release config lock previously held.
CLI Example:
.. code-block:: bash
salt '*' panos.remove_config_lock
u opu typeu? <request><config-lock><remove></remove></config-lock></request>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt remove_config_lock� s c C@ s� d } t d | � s) t d j | � f S| s> t d � � n | sd i d d 6d j | � d 6} n i d d 6d j | | � d 6} t d
| � S( uB
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
u 7.0.0u panos.is_required_versionuB The panos device requires version {0} or greater for this command.u, FQDN to resolve must be provided as address.u opu typeu< <request><resolve><address>{0}</address></resolve></request>u cmduL <request><resolve><vsys>{0}</vsys><address>{1}</address></resolve></request>u
panos.call( R
R R R ( R* R+ R R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt resolve_address� s
c C@ s@ | s t d � � n i d d 6d j | � d 6} t d | � S( u�
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
u Filename must not be empty.u opu typeu* <save><config><to>{0}</to></config></save>u cmdu
panos.call( R R R
( R# R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt save_device_config s c C@ s" i d d 6d d 6} t d | � S( u�
Save files needed to restore device to local disk.
CLI Example:
.. code-block:: bash
salt '*' panos.save_device_state
u opu typeu* <save><device-state></device-state></save>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt save_device_state4 s c C@ s� | s t d � � n i } i d d 6d d 6d d 6d j | � d 6} | j t d
| � � | t k r| | j t � � n | S( u�
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
u% Profile name option must not be none.u configu typeu setu actionu_ /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/authentication-profileu xpathu4 <authentication-profile>{0}</authentication-profile>u elementu
panos.call( R R t updateR
R" R ( t profilet deployt retR ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt set_authentication_profileD s
c C@ s� | s t d � � n i } i d d 6d d 6d d 6d j | � d 6} | j t d
| � � | t k r| | j t � � n | S( u�
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
u! Hostname option must not be none.u configu typeu setu actionuH /config/devices/entry[@name='localhost.localdomain']/deviceconfig/systemu xpathu <hostname>{0}</hostname>u elementu
panos.call( R R R� R
R" R ( t hostnameR� R� R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt set_hostnamei s
c C@ s� | t k r d } n! | t k r* d } n t d � � i } i d d 6d d 6d d 6d
j | � d 6} | j t d | � � | t k r� | j t � � n | S(
u�
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
u nou yesu3 Invalid option provided for service enabled option.u configu typeu setu actionuP /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/serviceu xpathu <disable-icmp>{0}</disable-icmp>u elementu
panos.call( R" R R R R� R
R ( t enabledR� t valueR� R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt set_management_icmp� s
c C@ s� | t k r d } n! | t k r* d } n t d � � i } i d d 6d d 6d d 6d
j | � d 6} | j t d | � � | t k r� | j t � � n | S(
u�
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
u nou yesu3 Invalid option provided for service enabled option.u configu typeu setu actionuP /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/serviceu xpathu <disable-http>{0}</disable-http>u elementu
panos.call( R" R R R R� R
R ( R� R� R� R� R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt set_management_http� s
c C@ s� | t k r d } n! | t k r* d } n t d � � i } i d d 6d d 6d d 6d
j | � d 6} | j t d | � � | t k r� | j t � � n | S(
u�
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
u nou yesu3 Invalid option provided for service enabled option.u configu typeu setu actionuP /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/serviceu xpathu" <disable-https>{0}</disable-https>u elementu
panos.call( R" R R R R� R
R ( R� R� R� R� R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt set_management_https� s
c C@ s� | t k r d } n! | t k r* d } n t d � � i } i d d 6d d 6d d 6d
j | � d 6} | j t d | � � | t k r� | j t � � n | S(
u�
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
u nou yesu3 Invalid option provided for service enabled option.u configu typeu setu actionuP /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/serviceu xpathu* <disable-http-ocsp>{0}</disable-http-ocsp>u elementu
panos.call( R" R R R R� R
R ( R� R� R� R� R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt set_management_ocsp s
c C@ s� | t k r d } n! | t k r* d } n t d � � i } i d d 6d d 6d d 6d
j | � d 6} | j t d | � � | t k r� | j t � � n | S(
u�
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
u nou yesu3 Invalid option provided for service enabled option.u configu typeu setu actionuP /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/serviceu xpathu <disable-snmp>{0}</disable-snmp>u elementu
panos.call( R" R R R R� R
R ( R� R� R� R� R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt set_management_snmp- s
c C@ s� | t k r d } n! | t k r* d } n t d � � i } i d d 6d d 6d d 6d
j | � d 6} | j t d | � � | t k r� | j t � � n | S(
u�
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
u nou yesu3 Invalid option provided for service enabled option.u configu typeu setu actionuP /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/serviceu xpathu <disable-ssh>{0}</disable-ssh>u elementu
panos.call( R" R R R R� R
R ( R� R� R� R� R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt set_management_sshU s
c C@ s� | t k r d } n! | t k r* d } n t d � � i } i d d 6d d 6d d 6d
j | � d 6} | j t d | � � | t k r� | j t � � n | S(
u�
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
u nou yesu3 Invalid option provided for service enabled option.u configu typeu setu actionuP /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/serviceu xpathu$ <disable-telnet>{0}</disable-telnet>u elementu
panos.call( R" R R R R� R
R ( R� R� R� R� R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt set_management_telnet} s
c
C@ sU i } | d k r' t j j d � � n | d k rH t j j d � � n | d k rp | rp t j j d � � n | d k r� | r� t j j d
� � n | d k r� | d k r� t j j d
� � n | d k r�| d k s� | d k r;i d d 6d d 6d d 6d j | | | � d 6} | j i t d | � d 6� n | d k sS| d k r2i d d 6d d 6d d 6d j | | | � d 6} | j i t d | � d 6� q2n�| d k rm| d k s�| d k ri d d 6d d 6d d 6d d 6} | j i t d | � d 6� n | d k s'| d k r2i d d 6d d 6d d 6d d 6} | j i t d | � d 6� q2n� | d k r2| d k s�| d k r�i d d 6d d 6d d 6d d 6} | j i t d | � d 6� n | d k s�| d k r2i d d 6d d 6d d 6d d 6} | j i t d | � d 6� q2n | t k rQ| j t � � n | S( u�
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
u primaryu secondaryu bothu2 Target option must be primary, secondary, or both.u symmetricu autokeyu noneu0 Type option must be symmetric, autokey, or both.uI When using symmetric authentication, authentication_key must be provided.u= When using symmetric authentication, key_id must be provided.u md5u sha1uC When using symmetric authentication, algorithm must be md5 or sha1.u configu typeu setu actionu{ /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/ntp-servers/primary-ntp-server/authentication-typeu xpathu� <symmetric-key><algorithm><{0}><authentication-key>{1}</authentication-key></{0}></algorithm><key-id>{2}</key-id></symmetric-key>u elementu
panos.callu primary_serveru} /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/ntp-servers/secondary-ntp-server/authentication-typeu secondary_serveru
<autokey/>u <none/>( u primaryu secondaryu both( u symmetricu autokeyu none( u md5u sha1( R t
exceptionsR R R� R
R" R ( t targett authentication_typet key_idt authentication_keyt algorithmR� R� R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt set_ntp_authentication� sv
!
$
!
$
!
$ c C@ s� i } | rX i d d 6d d 6d d 6d j | � d 6} | j i t d | � d
6� n | r� i d d 6d d 6d d 6d j | � d 6} | j i t d | � d 6� n | t k r� | j t � � n | S(
u�
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
u configu typeu setu actionug /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/ntp-servers/primary-ntp-serveru xpathu, <ntp-server-address>{0}</ntp-server-address>u elementu
panos.callu primary_serverui /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/ntp-servers/secondary-ntp-serveru secondary_server( R R� R
R" R ( t primary_servert secondary_serverR� R� R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt set_ntp_servers s
!
! c C@ s� | s t d � � n i } i d d 6d d 6d d 6d j | � d 6} | j t d
| � � | t k r| | j t � � n | S( u�
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
u! Address option must not be empty.u configu typeu setu actionuU /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/permitted-ipu xpathu <entry name='{0}'></entry>u elementu
panos.call( R R R� R
R" R ( R* R� R� R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt set_permitted_ipA s
c C@ s� | s t d � � n i } i d d 6d d 6d d 6d j | � d 6} | j t d
| � � | t k r| | j t � � n | S( u�
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
u& Timezone name option must not be none.u configu typeu setu actionuQ /config/devices/entry[@name='localhost.localdomain']/deviceconfig/system/timezoneu xpathu <timezone>{0}</timezone>u elementu
panos.call( R R R� R
R" R ( t tzR� R� R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt set_timezonef s
c C@ s" i d d 6d d 6} t d | � S( ur
Shutdown a running system.
CLI Example:
.. code-block:: bash
salt '*' panos.shutdown
u opu typeu9 <request><shutdown><system></system></shutdown></request>u cmdu
panos.call( R
( R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt shutdown� s u vr1c C@ sj d } | r" | d j | � 7} n | r> | d j | � 7} n | d 7} i d d 6| d 6} t d | � S( u;
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
u <test><routing><fib-lookup>u <ip>{0}</ip>u$ <virtual-router>{0}</virtual-router>u </fib-lookup></routing></test>u opu typeu cmdu
panos.call( R R
( t ipt vrRn R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt test_fib_route� s
c
C@ s5 d }
| r" |
d j | � 7}
n | r> |
d j | � 7}
n | rZ |
d j | � 7}
n | rv |
d j | � 7}
n | r� |
d j | � 7}
n | r� |
d j | � 7}
n | r� |
d j | � 7}
n | r� |
d j | � 7}
n | r� |
d
7}
n |
d 7}
i d d
6d j | � d 6|
d 6} t d | � S( u4
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
u <test><security-policy-match>u <from>{0}</from>u <to>{0}</to>u <source>{0}</source>u <destination>{0}</destination>u <protocol>{0}</protocol>u( <destination-port>{0}</destination-port>u <application>{0}</application>u <category>{0}</category>u <show-all>yes</show-all>u </security-policy-match></test>u opu typeu vsys{0}u vsysu cmdu
panos.call( R R
( t
sourcezonet destinationzonet sourcet destinationt protocolt portR[ t categoryR+ t allrulesRn R ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt test_security_policy� s0 *
c C@ s@ | s t d � � n i d d 6d j | � d 6} t d | � S( u�
Unlocks a locked administrator account.
username
Username of the administrator.
CLI Example:
.. code-block:: bash
salt '*' panos.unlock_admin username=bob
u! Username option must not be none.u opu typeuU <set><management-server><unlock><admin>{0}</admin></unlock></management-server></set>u cmdu
panos.call( R R R
( t usernameR ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt unlock_admin s
(s t __doc__t
__future__R R R t loggingR t salt.exceptionsR t salt.proxy.panosR t salt.utils.platformt getLoggert __name__t logR R t NoneR R R R R R R R R R R% R' R) R, R. R/ R0 R1 R2 R3 R4 R5 R6 R7 R8 R9 R: R; R< R= R> R? RA RB R RE RF RG RH RI RJ RK RL RR RS RT RU RV RW RX RY RZ R\ R^ R` Rb Rc Rd Re Rf Rg Rh Ri Rk Rl RM Rm Ro Rq Rr Rw Rx Ry Rz R| R} R~ R R� R� R� R" R� R� R� R� R� R� R� R� R� R� R� R� R� R� R� ( ( ( s6 /usr/lib/python2.7/site-packages/salt/modules/panos.pyt <module> s� ## 0 % %$((((((( k,%$ ! G
Mini Shell