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 EthernetInterface

© 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

EthernetInterface uses InterfaceType, XmlConvertible, PathableName, ReferenceableObject, ObjectWithDescription

Direct known subclasses

AggregateEthernetInterface
Located at network-classes/EthernetInterface.php
Methods summary
public
# __construct( string $name, EthernetIfStore $owner )

Parameters

$name
string
$name
$owner
EthernetIfStore
$owner
public
# load_from_domxml( DOMElement $xml )

Parameters

$xml
DOMElement
$xml
public
# load_sub_from_domxml( DOMElement $xml )

Parameters

$xml
DOMElement
$xml
public boolean
# isSubInterface( )

Returns

boolean
public string
# type( )

Returns

string
public integer
# tag( )

Returns

integer
public integer
# ae( )

Returns

integer
public integer
# subIfNumber( )

Returns

integer
public
# getLayer3IPv4Addresses( )
public
# getLayer3IPv6Addresses( )
public
# getLayer3IPAddresses( )
public
# countSubInterfaces( )
public EthernetInterface[]
# subInterfaces( )

Returns

EthernetInterface[]
public
# isEthernetType( )
public boolean
# setName( string $name )

return true if change was successful false if not (duplicate rulename?)

return true if change was successful false if not (duplicate rulename?)

Parameters

$name
string
$name new name for the rule

Returns

boolean
public boolean
# setTag( string $tag )

return true if change was successful false if not (duplicate rulename?)

return true if change was successful false if not (duplicate rulename?)

Parameters

$tag
string
$name new name for the rule

Returns

boolean
public boolean
# setAE( string $ae )

return true if change was successful false if not (duplicate rulename?)

return true if change was successful false if not (duplicate rulename?)

Parameters

$ae
string
$name new name for the rule

Returns

boolean
public boolean
# addIPv4Address( string $ip )

return true if change was successful false if not (duplicate ipaddress?)

return true if change was successful false if not (duplicate ipaddress?)

Parameters

$ip
string
$ip

Returns

boolean
public boolean
# API_addIPv4Address( Address $ip )

Add a ip to this interface, it must be passed as an object or string

Add a ip to this interface, it must be passed as an object or string

Parameters

$ip
Address
$ip Object to be added, or String

Returns

boolean
public boolean
# removeIPv4Address( string $ip )

return true if change was successful false if not (duplicate ipaddress?)

return true if change was successful false if not (duplicate ipaddress?)

Parameters

$ip
string
$ip

Returns

boolean
public boolean
# API_removeIPv4Address( Address $ip )

remove a ip address to this interface, it must be passed as an object or string

remove a ip address to this interface, it must be passed as an object or string

Parameters

$ip
Address
$ip Object to be added, or String

Returns

boolean
public boolean
# addIPv6Address( string $ip )

return true if change was successful false if not (duplicate ipaddress?)

return true if change was successful false if not (duplicate ipaddress?)

Parameters

$ip
string
$ip

Returns

boolean
public EthernetInterface
# addSubInterface( string $tag, mixed $name = "" )

return true if change was successful false if not (duplicate ipaddress?)

return true if change was successful false if not (duplicate ipaddress?)

Parameters

$tag
string
$ip
$name

Returns

EthernetInterface
public EthernetInterface
# API_addSubInterface( Address $tag )

Add a ip to this interface, it must be passed as an object or string

Add a ip to this interface, it must be passed as an object or string

Parameters

$tag
Address
$ip Object to be added, or String

Returns

EthernetInterface
public string &
# getXPath( )

Returns

string
Methods used from InterfaceType
(), (), (), (), (), ()
Methods used from XmlConvertible
(), (), (), (), ()
Methods used from PathableName
(), (), ()
Methods used from ReferenceableObject
(), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), (), ()
Methods used from ObjectWithDescription
(), (), (), (), ()
Properties summary
public EthernetIfStore $owner
#
public string $type 'tmp'
#
protected boolean $isSubInterface FALSE
#
protected EthernetInterface[] $subInterfaces array()
#
protected null|EthernetInterface $parentInterface null
#
protected integer $tag
#
protected integer $ae null
#
protected mixed $l3ipv4Addresses
#
protected mixed $l3ipv6Addresses
#
public static array $supportedTypes array('layer3', 'layer2', 'virtual-wire', 'tap', 'ha', 'aggregate-group', 'log-card', 'decrypt-mirror', 'empty')
#
public static string $templatexml '<entry name="**temporarynamechangeme**"> <layer3> <ipv6> <neighbor-discovery> <router-advertisement> <enable>no</enable> </router-advertisement> </neighbor-discovery> </ipv6> <ndp-proxy> <enabled>no</enabled> </ndp-proxy> <lldp> <enable>no</enable> </lldp> <ip></ip> </layer3> </entry>'
#
public static string $templatexmll2 '<entry name="**temporarynamechangeme**"> <layer2> <lldp> <enable>no</enable> </lldp> </layer2> </entry>'
#
public static string $templatexmlvw '<entry name="**temporarynamechangeme**"> <virtual-wire> <lldp> <enable>no</enable> </lldp> </virtual-wire> </entry>'
#
public static string $templatexmlae '<entry name="**temporarynamechangeme**"> <aggregate-group>ae1</aggregate-group> </entry>'
#
public static string $templatexmlsubl3 '<entry name="**temporarynamechangeme**"> <ipv6> <neighbor-discovery> <router-advertisement> <enable>no</enable> </router-advertisement> </neighbor-discovery> </ipv6> <ndp-proxy> <enabled>no</enabled> </ndp-proxy> <adjust-tcp-mss> <enable>no</enable> </adjust-tcp-mss> <tag></tag> <ip></ip> </entry>'
#
public static string $templatexmlsub '<entry name="**temporarynamechangeme**"> <tag></tag> </entry>'
#
Properties used from InterfaceType
$importedByVSYS
Properties used from XmlConvertible
$xmlroot
Properties used from ReferenceableObject
$name, $refcomphash, $refrules
Properties used from ObjectWithDescription
$_description
Magic properties used from PathableName
$name, $owner
Magic properties used from ObjectWithDescription
$xmlroot
PAN-OS-PHP API documentation generated by ApiGen 2.8.0