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 ServiceGroup

© 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

ServiceGroup uses PathableName, XmlConvertible, ServiceCommon
Located at object-classes/ServiceGroup.php
Methods summary
public
# __construct( mixed $name, mixed $owner = null, mixed $fromTemplateXml = FALSE )
public integer
# count( )

returns number of members in this group

returns number of members in this group

Returns

integer
public
# load_from_domxml( mixed $xml )
public
# setName( mixed $newName )

Parameters

$newName
mixed
$newName string
public
# API_setName( string $newName )

Parameters

$newName
string
$newName
public boolean
# addMember( Service|ServiceGroup $newObject, boolean $rewriteXml = TRUE )

Parameters

$newObject
Service|ServiceGroup
$newObject
$rewriteXml
boolean
$rewriteXml

Returns

boolean
public boolean
# API_removeMember( Service|ServiceGroup $objectToRemove )

Parameters

$objectToRemove
Service|ServiceGroup
objectToRemove

Returns

boolean
public boolean
# API_addMember( Service|ServiceGroup $newObject )

Add a member to this group, it must be passed as an object

Add a member to this group, it must be passed as an object

Parameters

$newObject
Service|ServiceGroup
$newObject Object to be added

Returns

boolean
public boolean
# removeMember( Service|ServiceGroup $old, boolean $rewritexml = TRUE )

Parameters

$old
Service|ServiceGroup
$old
$rewritexml
boolean
$rewritexml

Returns

boolean
public &
# getXPath( )
public boolean
# replaceReferencedObject( Service|ServiceGroup $old, Service|ServiceGroup $new )

Parameters

$old
Service|ServiceGroup
$old
$new
Service|ServiceGroup
$new

Returns

boolean

Throws

Exception
public
# API_replaceReferencedObject( mixed $old, mixed $new )
public
# rewriteXML( )
public
# referencedObjectRenamed( Service|ServiceGroup $h )

Parameters

$h
Service|ServiceGroup
$h
public
# isGroup( )
public boolean
# equals( Service|ServiceGroup $otherObject )

Parameters

$otherObject
Service|ServiceGroup
$otherObject

Returns

boolean
true if objects have same same and values
public boolean
# sameValue( ServiceGroup $otherObject )

Parameters

$otherObject
ServiceGroup
$otherObject

Returns

boolean
true if both objects contain same objects names
public &
# getValueDiff( ServiceGroup $otherObject )
public string|
# displayValueDiff( ServiceGroup $otherObject, integer $indent = 0, boolean|false $toString = FALSE )

Parameters

$otherObject
ServiceGroup
$otherObject
$indent
integer
$indent
$toString
boolean|false
$toString

Returns

string|
public ServiceDstPortMapping
# dstPortMapping( )

Returns

ServiceDstPortMapping
public
# xml_convert_to_v6( )
public Service[]|ServiceGroup[] &
# expand( boolean $keepGroupsInList = FALSE )

Parameters

$keepGroupsInList
boolean
$keepGroupsInList

Returns

Service[]|ServiceGroup[]
list of all member objects, if some of them are groups, they are exploded and their members inserted
public Service[]|ServiceGroup[]
# members( )

Returns

Service[]|ServiceGroup[]
public boolean
# hasObjectRecursive( Service|ServiceGroup $object )

Parameters

$object
Service|ServiceGroup
$object

Returns

boolean
public boolean
# hasNamedObjectRecursive( string $objectName )

Parameters

$objectName
string
$objectName

Returns

boolean
public
# removeAll( mixed $rewriteXml = TRUE )
public
# replaceGroupbyService( mixed $padding = "" )
public
# replaceByMembersAndDelete( mixed $padding = "", mixed $isAPI = FALSE, mixed $rewriteXml = TRUE, mixed $forceAny = FALSE )
Methods used from PathableName
(), (), ()
Methods used from XmlConvertible
(), (), (), (), ()
Methods used from ServiceCommon
(), (), (), (), (), (), (), (), (), ()
Methods used from ReferenceableObject
(), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), removeReference()(as super_removeReference())
Properties summary
public Service[]|ServiceGroup[] $members array()
#
public null|ServiceStore $owner null
#
public TagRuleContainer $tags
#
protected static string $templatexml '<entry name="**temporarynamechangeme**"><members></members></entry>'
#
protected static mixed $templatexmlroot null
#
Properties used from XmlConvertible
$xmlroot
Magic properties used from PathableName
$name, $owner
PAN-OS-PHP API documentation generated by ApiGen 2.8.0