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 ServiceStore

© 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

ServiceStore uses PathableName, XmlConvertible
Located at object-classes/ServiceStore.php
Methods summary
public
# __construct( mixed $owner )
public
# load_services_from_domxml( DOMElement $xml )

Parameters

$xml
DOMElement
$xml
public Service[]|ServiceGroup[]
# all( mixed $withFilter = null, boolean $sortByDependencies = FALSE )

Returns an Array with all Service , ServiceGroups, TmpService objects in this store

Returns an Array with all Service , ServiceGroups, TmpService objects in this store

Parameters

$withFilter
mixed
$withFilter string|null
$sortByDependencies
boolean
$sortByDependencies

Returns

Service[]|ServiceGroup[]
public Service[]
# serviceObjects( )

Returns

Service[]
public ServiceGroup[]
# serviceGroups( mixed $sortByDependencies = TRUE )

Returns

ServiceGroup[]

Var

bool $sortByDependencies
public Service[]
# serviceTmpObjects( )

Returns

Service[]
public
# load_servicegroups_from_domxml( mixed $xml )

Parameters

$xml
mixed
$xml DOMElement
public
# count( )
public
# countServiceGroups( )

returns the count of ServiceGroups in this store

returns the count of ServiceGroups in this store

public
# countServices( )

returns the count of Services (ie not groups) in this store

returns the count of Services (ie not groups) in this store

public
# countTmpServices( )
public null|Service|ServiceGroup
# find( string $objectName, null $ref = null, boolean $nested = TRUE )

Parameters

$objectName
string
$objectName
$ref
null
$ref
$nested
boolean
$nested

Returns

null|Service|ServiceGroup
public null|Service|ServiceGroup
# findOrCreate( mixed $fn, null $ref = null, boolean|true $nested = TRUE )

Parameters

$fn
mixed
$fn
$ref
null
$ref
$nested
boolean|true
$nested

Returns

null|Service|ServiceGroup
public null|Service
# findTmpService( mixed $name )

Parameters

$name
mixed
$name

Returns

null|Service
public boolean
# remove( Service|ServiceGroup $s, boolean $cleanInMemory = FALSE )

Parameters

$s
Service|ServiceGroup
$s
$cleanInMemory
boolean
$cleanInMemory

Returns

boolean
public boolean
# API_remove( Service|ServiceGroup $s, boolean $cleanInMemory = FALSE )

Parameters

$s
Service|ServiceGroup
$s
$cleanInMemory
boolean
$cleanInMemory

Returns

boolean
public
# rewriteServiceStoreXML( )
public
# rewriteServiceGroupStoreXML( )
public boolean
# add( Service|ServiceGroup $s, boolean $rewriteXml = TRUE )

Parameters

$s
Service|ServiceGroup
$s
$rewriteXml
boolean
$rewriteXml

Returns

boolean

Throws

Exception
public &
# getServiceStoreXPath( )
public &
# getServiceGroupStoreXPath( )
public Service
# newService( mixed $name, mixed $protocol, mixed $destinationPorts, mixed $description = '', mixed $sourcePorts = null )

Parameters

$name
mixed
$name string
$protocol
mixed
$protocol string
$destinationPorts
mixed
$destinationPorts string
$description
mixed
$description string
$sourcePorts

Returns

Service

Throws

Exception
public Service
# API_newService( mixed $name, mixed $protocol, mixed $destinationPorts, mixed $description = '', mixed $sourcePorts = null )

Parameters

$name
mixed
$name string
$protocol
mixed
$protocol string
$destinationPorts
mixed
$destinationPorts string
$description
mixed
$description string
$sourcePorts

Returns

Service

Throws

Exception
public ServiceGroup
# newServiceGroup( string $name )

Creates a new Service Group named '$name' . Will exit with error if a group with that name already exists

Creates a new Service Group named '$name' . Will exit with error if a group with that name already exists

Parameters

$name
string
$name

Returns

ServiceGroup
public ServiceGroup
# API_newServiceGroup( mixed $name )

Creates a new Service Group named '$name' . Will exit with error if a group with that name already exists

Creates a new Service Group named '$name' . Will exit with error if a group with that name already exists

Parameters

$name
mixed
$name string

Returns

ServiceGroup
public
# createTmp( mixed $name, mixed $ref = null )
public Service[]|ServiceGroup[]
# nestedPointOfView( )

Returns

Service[]|ServiceGroup[]
public boolean
# referencedObjectRenamed( Service|ServiceGroup $h, mixed $oldName )

Parameters

$h
Service|ServiceGroup
$h
$oldName
mixed
$oldName

Returns

boolean
public boolean
# inStore( Service|ServiceGroup $object )

Parameters

$object
Service|ServiceGroup
$object

Returns

boolean
public
# countUnused( )
public
# countUnusedServices( )
public
# countUnusedServiceGroups( )
public string
# findAvailableName( string $base, string $nested = TRUE, integer|string $suffix = '', mixed $startCount = '' )

Parameters

$base
string
$base * @param bool $nested
$nested
string
$suffix
$suffix
integer|string
$startCount
$startCount

Returns

string
public
# findByProtocolDstSrcPort( mixed $protocol, mixed $destinationPort, mixed $sourcePort = "" )
public
# replaceServiceWith( mixed $object, mixed $newObjectName, mixed $padding, mixed $isAPI )
Methods used from PathableName
(), (), ()
Methods used from XmlConvertible
(), (), (), (), ()
Properties summary
public PanoramaConf|PANConf|VirtualSystem|DeviceGroup $owner
#
public null|ServiceStore $parentCentralStore null
#
protected boolean $appdef FALSE
#
protected Service[]|ServiceGroup[] $_all array()
#
protected Service[] $_serviceObjects array()
#
protected ServiceGroup[] $_serviceGroups array()
#
protected Service[] $_tmpServices array()
#
public DOMElement $serviceRoot
#
public DOMElement $serviceGroupRoot
#
Properties used from XmlConvertible
$xmlroot
Magic properties used from PathableName
$name, $owner
PAN-OS-PHP API documentation generated by ApiGen 2.8.0