Class AddressObject

Models network address configurations for PAN-OS as a VersionedPanObject. Contains details such as address value, type, description, and associated tags.

Hierarchy

VersionedPanObject
- AddressObject

Index

Constructors

constructor

new AddressObject(name, value, type?, description?, tag?): AddressObject
Creates a new AddressObject instance.
Parameters
- name: string
  The unique name identifying the address object.
- value: string
  The value that the object configures (e.g., IP address, subnet, range).
- type: AddressType = 'ip-netmask'
  The type of address represented by the object.
- Optional description: string
  A description of the address object (default is undefined).
- Optional tag: string[]
  An array of tags to associate with the address object (default is undefined).
Returns AddressObject
Overrides VersionedPanObject.constructor
- Defined in models/AddressObject.ts:43

Properties

`Protected` _apiClient

_apiClient: null | ApiClient

`Protected` children

children: PanObject[]

`Optional` description

description?: string

An optional description providing additional information about the address object.

name

name: string

`Protected` parent

parent: null | PanObject

`Optional` tag

tag?: string[]

Tags associated with the address object for organizational purposes.

type

type: AddressType

The type of the network address, indicating its format.

value

value: string

The specific network address value (e.g., IP address, IP range).

Accessors

apiClient

get apiClient(): ApiClient
Retrieves the ApiClient from the current instance or its parent hierarchy.

Returns ApiClient
The ApiClient associated with this object.

Throws
An error if the ApiClient instance is not found in the hierarchy.
Inherited from VersionedPanObject.apiClient
- Defined in models/PanObject.ts:34

Methods

addChild

addChild(child): void
Adds a PanObject as a child to this object, establishing a parent-child relationship.
Parameters
- child: PanObject
  The PanObject to be added as a child.
Returns void
Inherited from VersionedPanObject.addChild
- Defined in models/PanObject.ts:49

apply

apply(): Promise<void>
Issues an API request to apply changes to this configuration object on the PAN-OS device. It effectively replaces the object at its XPath location with the current object state.

Returns Promise<void>
A promise that resolves once the changes have been successfully applied.
Inherited from VersionedPanObject.apply
- Defined in models/VersionedPanObject.ts:54

create

create(): Promise<void>
Issues an API request to create this configuration object on the PAN-OS device.

Returns Promise<void>
A promise that resolves once the object has been successfully created.
Inherited from VersionedPanObject.create
- Defined in models/VersionedPanObject.ts:40

find

find<ObjectType>(name, classType?): null | ObjectType
Locates a child PanObject within the configuration tree by name and, optionally, by type.
Type Parameters
- ObjectType extends PanObject
Parameters
- name: string
  The name of the object to search for.
- Optional classType: (new (...args) => ObjectType)
  Optional. The class constructor to match instances against.
  - - new (...args): ObjectType
    - Parameters
      Rest ...args: unknown[]
      Returns ObjectType
Returns null | ObjectType
The matching PanObject instance, or null if not found.
Inherited from VersionedPanObject.find
- Defined in models/PanObject.ts:103

findChildByName

findChildByName(name): null | PanObject
Searches for a child PanObject by its name.
Parameters
- name: string
  The name of the child object to locate.
Returns null | PanObject
The found PanObject, or null if no match is found.
Inherited from VersionedPanObject.findChildByName
- Defined in models/PanObject.ts:82

getChildren

getChildren(): readonly PanObject[]
Retrieves the child PanObject instances of this object.

Returns readonly PanObject[]
An array of PanObject representing the children of this object.
Inherited from VersionedPanObject.getChildren
- Defined in models/PanObject.ts:72

getXpath

getXpath(): string
Provides the XPath for identifying this specific address object in PAN-OS configuration XML.

Returns string
The address object's XPath as a string.
Overrides VersionedPanObject.getXpath
- Defined in models/AddressObject.ts:71

hasChild

hasChild(child): boolean
Checks if a given PanObject is a child of this object.
Parameters
- child: PanObject
  The PanObject to verify.
Returns boolean
true if the specified PanObject is a child of this object, otherwise false.
Inherited from VersionedPanObject.hasChild
- Defined in models/PanObject.ts:92

`Protected` parseConfigObjects

parseConfigObjects(config): AddressObject[]
Parses a configuration payload into instances of AddressObject.
Parameters
- config: AddressObjectConfig
  Configuration data from PAN-OS API response, specific to AddressObject settings.
Returns AddressObject[]
An array of AddressObject instances derived from the configuration data.
Overrides VersionedPanObject.parseConfigObjects
- Defined in models/AddressObject.ts:104

removeChild

removeChild(child): void
Removes a PanObject from this object's children, severing the parent-child relationship.
Parameters
- child: PanObject
  The PanObject to be removed from the children.
Returns void
Inherited from VersionedPanObject.removeChild
- Defined in models/PanObject.ts:59

toXml

toXml(): string
Generates an XML representation of the address object for interaction with PAN-OS API.

Returns string
The XML string representing this address object.
Overrides VersionedPanObject.toXml
- Defined in models/AddressObject.ts:80

`Static` getXpath

getXpath(): string
Static method to generate the XPath for the address objects in PAN-OS configuration XML.

Returns string
The address objects XPath as a string.
- Defined in models/AddressObject.ts:62

Class AddressObject

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

name: string

value: string

type: AddressType = 'ip-netmask'

Optional description: string

Optional tag: string[]

Returns AddressObject

Properties

Protected _apiClient

Protected children

Optional description

name

Protected parent

Optional tag

type

value

Accessors

apiClient

Returns ApiClient

Throws

Methods

addChild

Parameters

child: PanObject

Returns void

apply

Returns Promise<void>

create

Returns Promise<void>

find

Type Parameters

ObjectType extends PanObject

Parameters

name: string

Optional classType: (new (...args) => ObjectType)

Parameters

Rest ...args: unknown[]

Returns ObjectType

Returns null | ObjectType

findChildByName

Parameters

name: string

Returns null | PanObject

getChildren

Returns readonly PanObject[]

getXpath

Returns string

hasChild

Parameters

child: PanObject

Returns boolean

Protected parseConfigObjects

Parameters

config: AddressObjectConfig

Returns AddressObject[]

removeChild

Parameters

child: PanObject

Returns void

toXml

Returns string

Static getXpath

Returns string

Settings

Member Visibility

Theme

On This Page

`Optional` description: string

`Optional` tag: string[]

`Protected` _apiClient

`Protected` children

`Optional` description

`Protected` parent

`Optional` tag

`Optional` classType: (new (...args) => ObjectType)

`Rest` ...args: unknown[]

`Protected` parseConfigObjects

`Static` getXpath