Overview

Namespaces

  • None
  • PHP

Classes

  • Address
  • AddressGroup
  • AddressRuleContainer
  • AddressStore
  • AggregateEthernetIfStore
  • AggregateEthernetInterface
  • App
  • AppOverrideRule
  • AppRuleContainer
  • AppStore
  • AuthenticationRule
  • CaptivePortalRule
  • cidr
  • Container
  • CsvParser
  • CustomSecurityProfileURL
  • DecryptionProfile
  • DecryptionRule
  • DeviceCloud
  • DeviceGroup
  • DH
  • DoSRule
  • ErrorReporter
  • EthernetIfStore
  • EthernetInterface
  • ExpeditionTaskReporter
  • FawkesConf
  • FileTaskReporter
  • HipObjectsProfile
  • HipProfilesProfile
  • IkeCryptoProfil
  • IkeCryptoProfileStore
  • IKEGateway
  • IKEGatewayStore
  • InterfaceContainer
  • IP4Map
  • IPSecCryptoProfil
  • IPSecCryptoProfileStore
  • IPsecTunnel
  • IPsecTunnelStore
  • LoopbackIfStore
  • LoopbackInterface
  • ManagedDevice
  • ManagedDeviceStore
  • NatRule
  • NetworkPropertiesContainer
  • ObjRuleContainer
  • ObjStore
  • PanAPIConnector
  • PANConf
  • PanoramaConf
  • PbfRule
  • PH
  • PredefinedSecurityProfileURL
  • QoSRule
  • RQuery
  • Rule
  • RuleStore
  • RuleWithUserID
  • Schedule
  • ScheduleStore
  • SecurityProfile
  • SecurityProfileAntiSpyware
  • SecurityProfileAntiVirus
  • SecurityProfileDNSSecurity
  • SecurityProfileFileBlocking
  • SecurityProfileGroup
  • SecurityProfileGroupStore
  • SecurityProfileStore
  • SecurityProfileURL
  • SecurityProfileVirusAndWildfire
  • SecurityProfileVulnerability
  • SecurityProfileWildfire
  • SecurityRule
  • Service
  • ServiceDstPortMapping
  • ServiceGroup
  • ServiceRuleContainer
  • ServiceSrcPortMapping
  • ServiceStore
  • StaticRoute
  • Tag
  • TagRuleContainer
  • TagStore
  • Template
  • TemplateStack
  • TmpInterface
  • TmpInterfaceStore
  • TunnelIfStore
  • TunnelInterface
  • UrlCategoryRuleContainer
  • VirtualRouter
  • VirtualRouterContainer
  • VirtualRouterStore
  • VirtualSystem
  • VirtualWire
  • VirtualWireStore
  • VlanIfStore
  • VlanInterface
  • Zone
  • ZoneRuleContainer
  • ZoneStore

Interfaces

  • TaskReporter

Traits

  • AddressCommon
  • centralAddressStore
  • centralAddressStoreUser
  • centralServiceStore
  • centralServiceStoreUser
  • InterfaceType
  • NegatableRule
  • ObjectWithDescription
  • PanSubHelperTrait
  • PathableName
  • ReferenceableObject
  • RulewithLogging
  • ServiceCommon
  • XmlConvertible

Functions

  • __CmpObjMemID
  • __CmpObjName
  • array_diff_no_cast
  • array_to_devicequery
  • array_unique_no_cast
  • cloneArray
  • convert
  • derr
  • findConnector
  • findConnectorOrDie
  • getDirContents
  • insertAfter
  • lastIndex
  • mdeb
  • mwarning
  • my_shutdown
  • myAutoloader
  • myErrorHandler
  • printn
  • removeElement
  • sortArrayByStartValue
  • yesNoBool
  • Overview
  • Namespace
  • Class
  • Tree

Class PH

© 2019 Palo Alto Networks, Inc. All rights reserved.

Licensed under SCRIPT SOFTWARE AGREEMENT, Palo Alto Networks, Inc., at https://www.paloaltonetworks.com/legal/script-software-license-1-0.pdf

Located at misc-classes/PH.php
Methods summary
public
# __construct( mixed $argv, mixed $argc )
public static
# decrypt( mixed $ciphertext, mixed $key )
public static
# frameworkVersion( )
public static boolean
# frameworkVersion_isGreaterThan( string $versionString )

Parameters

$versionString
string
$versionString ie: '1.2.3' or '1.5'

Returns

boolean
public static boolean
# frameworkVersion_isGreaterOrEqualThan( string $versionString )

Parameters

$versionString
string
$versionString ie: '1.2.3' or '1.5'

Returns

boolean
public static
# enableExceptionSupport( )

will throw Exceptions instead of print errors (useful for web embeded or scrips that want to support errors handling without quiting.

will throw Exceptions instead of print errors (useful for web embeded or scrips that want to support errors handling without quiting.

public static
# disableExceptionSupport( )
public static
# enableOutputFormatting( )
public static
# disableOutputFormatting( )
public static
# processCliArgs( )
public static
# generate_arguments( mixed $in = "", mixed $out = "", mixed $location = "", mixed $actions = "", mixed $filter = "", mixed $subquery = "", mixed $additional = "" )
public static string[] &
# processIOMethod( mixed $str, boolean $checkFileExists )

Parameters

$str
mixed
$str
$checkFileExists
boolean
$checkFileExists

Returns

string[]
public static integer
# versionFromString( string $text )

Parameters

$text
string
$text

Returns

integer
public static string
# list_to_string( string|ReferenceableObject[] & $array, mixed $separator = ', ' )

Parameters

$array
string|ReferenceableObject[]
$array
$separator

Returns

string
public static
# print_stdout( mixed $text )
public static &
# boldText( mixed $msg )
public static &
# underlineText( mixed $msg )
public static &
# italicText( mixed $msg )
public static &
# strikethroughText( mixed $msg )
public static &
# coloredText( mixed $msg, mixed $foreground_color = 'red', mixed $background_color = 'grey' )
public static PANConf|PanoramaConf
# findRootObjectOrDie( mixed $panConfObject )

Parameters

$panConfObject
mixed
$panConfObject

Returns

PANConf|PanoramaConf

Throws

Exception
public static PANConf|PanoramaConf|DeviceGroup|VirtualSystem|FawkesConf|Container
# findLocationObjectOrDie( mixed $panConfObject )

Parameters

$panConfObject
mixed
$panConfObject

Returns

PANConf|PanoramaConf|DeviceGroup|VirtualSystem|FawkesConf|Container

Throws

Exception
public static PANConf|PanoramaConf|DeviceGroup|VirtualSystem|FawkesConf|Container
# findLocationObject( mixed $panConfObject )

Parameters

$panConfObject
mixed
$panConfObject

Returns

PANConf|PanoramaConf|DeviceGroup|VirtualSystem|FawkesConf|Container

Throws

Exception
public static string
# getLocationString( PathableName $panConfObject )

Parameters

$panConfObject
PathableName
$panConfObject

Returns

string

Throws

Exception
public static PANConf|PanoramaConf
# getPanObjectFromConf( string $filename )

Parameters

$filename
string
$filename

Returns

PANConf|PanoramaConf
Properties summary
public static boolean $UseDomXML TRUE
#
public static null|mixed[] $args array()
#
public static array $argv array()
#
public static boolean $ignoreDestructors FALSE
#
public static boolean $useExceptions FALSE
#
public static boolean $outputFormattingEnabled TRUE
#
public static boolean $enableXmlDuplicatesDeletion FALSE
#
public static boolean $ignoreInvalidAddressObjects FALSE
#

set to true if you want to ignore invalid address objects but print a warning instead

set to true if you want to ignore invalid address objects but print a warning instead

public static boolean $sendAPIkeyviaHeader TRUE
#

set to true if you want to send API key via HEADER - possible starting with PAN-OS 9.0

set to true if you want to send API key via HEADER - possible starting with PAN-OS 9.0

public static boolean $saveAPIkey TRUE
#
public static boolean $displayCurlRequest FALSE
#
public static boolean $shadow_reducexml FALSE
#
public static boolean $shadow_json FALSE
#
public static array $JSON_OUT array()
#
public static mixed $basedir
#
public static string $softwareupdate_key "658d787f293e631196dac9fb29490f1cc1bb3827"
#
public static string $softwareupdate_user_encrypt "NmPyrGw7WYXdu5cdgm2x7HEkDf4LTHob7M/JNNhS+3CIfV5DkV7Tne8xersHIRafbXV3vzgIRECsG06Hs+O80g=="
#
public static string $softwareupdate_pw_encrypt "wbCEjb8jaYH36HHvB2PmLMNyaz27MvHgM+Bn64wnofCjrV/4G+25AkoqG+q41Cvigc9uUxBTbOUtW2EhQOPYjA=="
#
public static string $update_key_digest "0e05fc22c2a11cdc50196ae8aa09cb38f7c0b5fe"
#
public static string $update_user_encrypt_digest "MTJcbc7pFOrFs+rZ9uCISFxtT4dPA2dPy1HfRl7AE+yxsCc8n3Z/jvJNIVzXxZRQGGOtYxc0FarqLkPAd/O7q+JXHrcTr7L1kuubmJSRqQs="
#
public static string $update_pw_encrypt_digest "Ih+mfx64Mt4m7JX7xnMsCBE8lqfQynTKtiySA9nRD4ndViEOKFOIDemoT0LpTLfaAQWjEpPCU248KApeIUtmDvS3c7KVRyKC0qWXRNQ1Vmc="
#
public static string $license_key_digest "0b38638ba85f97482953570bec1f7e41fff7c533"
#
public static string $license_user_encrypt_digest "6gtYixyTgBf/lBfxPzor8hqI8cmrvtn06UskXAb5EWBhQHuJm7/0J9WfZbH8lk3AAWnUhpaG/NWlGdDevT5PMKPSQUawo4V2Tl8IbNB2Nnw="
#
public static string $license_pw_encrypt__digest "hdRb8p8a8vKDpuhdfDnDkDWaZRUthNCE0EDqZSBx2mNy+gqakPa74GJJAINJfC+HCZqtYs0ut/uxs1nOAcEXQlRqppEXuy+s1MNoMULt4DM="
#
PAN-OS-PHP API documentation generated by ApiGen 2.8.0