Class FWRule

Hierarchy (view full)

_ObjectSubSite
- FWRule

Implements

Partial<IFWRule>

Constructors

constructor

new FWRule(config, props): FWRule
Parameters
- config: IObjectSubSiteConfig
- props: IFWV4RuleRaw | IFWV6RuleRaw
Returns FWRule
Overrides _ObjectSubSite.constructor
- Defined in src/Firewall/FWRule.ts:142

Properties

_id

_id: string

action

action: FWRuleActions

`Optional` dst_address

dst_address?: string

dst_firewallgroup_ids

dst_firewallgroup_ids: string[]

`Optional` dst_networkconf_id

dst_networkconf_id?: string

`Optional` dst_networkconf_type

dst_networkconf_type?: string

`Optional` dst_port

dst_port?: string

enabled

enabled: boolean

`Optional` icmp_typename

icmp_typename?: icmpTypeV4

`Optional` icmpv6_typename

icmpv6_typename?: string

ipsec

ipsec: string

logging

logging: boolean

name

name: string

`Optional` protocol

protocol?: string

protocol_match_excepted

protocol_match_excepted: boolean

`Optional` protocol_v6

protocol_v6?: string

rule_index

rule_index: string | number

ruleset

ruleset: ruleSet

`Optional` setting_preference

setting_preference?: string

site_id

site_id: string

`Optional` src_address

src_address?: string

src_firewallgroup_ids

src_firewallgroup_ids: string[]

src_mac_address

src_mac_address: string

`Optional` src_networkconf_id

src_networkconf_id?: string

`Optional` src_networkconf_type

src_networkconf_type?: string

state_established

state_established: boolean

state_invalid

state_invalid: boolean

state_new

state_new: boolean

state_related

state_related: boolean

Accessors

`Protected` config

get config(): IObjectSubSiteConfigComplete
Returns IObjectSubSiteConfigComplete
Inherited from _ObjectSubSite.config
- Defined in src/commons/_ObjectSubSite.ts:31
set config(value): void
Parameters
- value: IObjectSubSiteConfigComplete
Returns void
Inherited from _ObjectSubSite.config
- Defined in src/commons/_ObjectSubSite.ts:35

`Protected` controller

get controller(): Controller
Returns Controller
Inherited from _ObjectSubSite.controller
- Defined in src/commons/_ObjectSubController.ts:31
set controller(value): void
Parameters
- value: Controller
Returns void
Inherited from _ObjectSubSite.controller
- Defined in src/commons/_ObjectSubController.ts:35

`Protected` controllerInstance

get controllerInstance(): AxiosInstance
Returns AxiosInstance
Inherited from _ObjectSubSite.controllerInstance
- Defined in src/commons/_ObjectSubController.ts:24
set controllerInstance(value): void
Parameters
- value: AxiosInstance
Returns void
Inherited from _ObjectSubSite.controllerInstance
- Defined in src/commons/_ObjectSubController.ts:28

`Protected` debug

get debug(): Debugger
Returns Debugger
Inherited from _ObjectSubSite.debug
- Defined in src/commons/_ObjectSubController.ts:144
set debug(value): void
Parameters
- value: Debugger
Returns void
Inherited from _ObjectSubSite.debug
- Defined in src/commons/_ObjectSubController.ts:148

`Protected` instance

get instance(): AxiosInstance
Returns AxiosInstance
Inherited from _ObjectSubSite.instance
- Defined in src/commons/_ObjectSubSite.ts:14

`Protected` privateMap

get privateMap(): WeakMap<any, any>
Returns WeakMap<any, any>
Inherited from _ObjectSubSite.privateMap
- Defined in src/commons/ObjectWithPrivateValues.ts:28

`Protected` site

get site(): Site
Returns Site
Inherited from _ObjectSubSite.site
- Defined in src/commons/_ObjectSubController.ts:38
set site(value): void
Parameters
- value: Site
Returns void
Inherited from _ObjectSubSite.site
- Defined in src/commons/_ObjectSubController.ts:42

Methods

`Protected` checkNeedVersion

checkNeedVersion(minVersion?, unifiOs?, parameterName?): void
Parameters
- Optional minVersion: string
  the minimal semver version for this object
- Optional unifiOs: boolean
  need to be unifiOs ? or Unifi Controller ? if no need, pass undefined
- parameterName: string = ''
  a name for the parameter
Returns void
Inherited from _ObjectSubSite.checkNeedVersion
- Defined in src/commons/_ObjectSubController.ts:104

`Protected` checkNeeds

checkNeeds(minVersion?, unifiOs?): boolean
Parameters
- Optional minVersion: string
- Optional unifiOs: boolean
Returns boolean
Inherited from _ObjectSubSite.checkNeeds
- Defined in src/commons/_ObjectSubController.ts:94

delete

delete(): Promise<void>
Returns Promise<void>
- Defined in src/Firewall/FWRule.ts:162

getController

getController(): Controller
Returns Controller
Inherited from _ObjectSubSite.getController
- Defined in src/commons/_ObjectSubController.ts:79

getInstance

getInstance(): AxiosInstance
Returns AxiosInstance
Inherited from _ObjectSubSite.getInstance
- Defined in src/commons/_ObjectSubController.ts:75

`Protected` getPrivate

getPrivate<T>(key): T
Type Parameters
- T
  the type retrieve.
Parameters
- key: string
  the key to retrieve
Returns T
Inherited from _ObjectSubSite.getPrivate
- Defined in src/commons/ObjectWithPrivateValues.ts:11

`Protected` import

import(props): this
Parameters
- props: IFWV4RuleRaw | IFWV6RuleRaw
Returns this
Overrides _ObjectSubSite.import
- Defined in src/Firewall/FWRule.ts:43

`Protected` mapObject

mapObject<U>(constructor, object): U
Type Parameters
- U extends _ObjectSubSite
Parameters
- constructor: (new (config, props) => U)
  the construtor to map the object
  - - new (config, props): U
    - Parameters
      config: IObjectSubSiteConfig
      props: any
      Returns U
- object: any
  the properties passed to the constructor if defined
Returns U
Inherited from _ObjectSubSite.mapObject
- Defined in src/commons/_ObjectSubSite.ts:60

`Protected` needVersion

needVersion<T>(key, value?, minVersion?, unifiOs?, allowUndefined?): boolean
Type Parameters
- T
Parameters
- key: keyof FWRule
  the key object that need to be only supported on some versions
- Optional value: T
  the value store in this object
- Optional minVersion: string
  the minimal semver version for this object
- Optional unifiOs: boolean
  need to be unifiOs ? or Unifi Controller ? if no need, pass undefined
- allowUndefined: boolean = false
  to undefined check ?
Returns boolean
Inherited from _ObjectSubSite.needVersion
- Defined in src/commons/_ObjectSubController.ts:116

save

save(): Promise<void>
Returns Promise<void>
- Defined in src/Firewall/FWRule.ts:152

`Protected` setPrivate

setPrivate<T>(key, value): void
Type Parameters
- T
  the type to set.
Parameters
- key: string
  the key to set
- value: T
  the value
Returns void
Inherited from _ObjectSubSite.setPrivate
- Defined in src/commons/ObjectWithPrivateValues.ts:21

toJSON

toJSON(): Partial<FWRule>
Returns Partial<FWRule>
Inherited from _ObjectSubSite.toJSON
- Defined in src/commons/_ObjectSubController.ts:59

Class FWRule

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns FWRule

Properties

_id

action

Optional dst_address

dst_firewallgroup_ids

Optional dst_networkconf_id

Optional dst_networkconf_type

Optional dst_port

enabled

Optional icmp_typename

Optional icmpv6_typename

ipsec

logging

name

Optional protocol

protocol_match_excepted

Optional protocol_v6

rule_index

ruleset

Optional setting_preference

site_id

Optional src_address

src_firewallgroup_ids

src_mac_address

Optional src_networkconf_id

Optional src_networkconf_type

state_established

state_invalid

state_new

state_related

Accessors

Protected config

Returns IObjectSubSiteConfigComplete

Parameters

Returns void

Protected controller

Returns Controller

Parameters

Returns void

Protected controllerInstance

Returns AxiosInstance

Parameters

Returns void

Protected debug

Returns Debugger

Parameters

Returns void

Protected instance

Returns AxiosInstance

Protected privateMap

Returns WeakMap<any, any>

Protected site

Returns Site

Parameters

Returns void

Methods

Protected checkNeedVersion

Parameters

Returns void

Protected checkNeeds

Parameters

Returns boolean

delete

Returns Promise<void>

getController

Returns Controller

getInstance

Returns AxiosInstance

`Optional` dst_address

`Optional` dst_networkconf_id

`Optional` dst_networkconf_type

`Optional` dst_port

`Optional` icmp_typename

`Optional` icmpv6_typename

`Optional` protocol

`Optional` protocol_v6

`Optional` setting_preference

`Optional` src_address

`Optional` src_networkconf_id

`Optional` src_networkconf_type

`Protected` config

`Protected` controller

`Protected` controllerInstance

`Protected` debug

`Protected` instance

`Protected` privateMap

`Protected` site

`Protected` checkNeedVersion

`Protected` checkNeeds

`Protected` getPrivate

`Protected` import

`Protected` mapObject

`Protected` needVersion

`Protected` setPrivate