Class RPCSwitchConfigurator

Hierarchy

SwitchConfigurator
- RPCSwitchConfigurator

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new RPCSwitchConfigurator(rpc: RPCProvider, targetId: string): RPCSwitchConfigurator

Overrides GenericSwitchConfigurator.constructor
- Defined in src/connector/classwrapper/SwitchConfigurator.ts:12
Parameters
- rpc: RPCProvider
- targetId: string
Returns RPCSwitchConfigurator

Properties

Private rpc

rpc: RPCProvider

Private targetId

targetId: string

Methods

applyConfig

applyConfig(): Promise<void>

- Defined in src/connector/classwrapper/SwitchConfigurator.ts:42
Apply config to device.

This method must called after modifying the configuration.

Returns Promise<void>

getAllVLAN

getAllVLAN(): Promise<VLAN[]>

Overrides GenericSwitchConfigurator.getAllVLAN
- Defined in src/connector/classwrapper/SwitchConfigurator.ts:97
Return all available VLANs

Returns Promise<VLAN[]>
Available all VLANs

getSwitchPorts

getSwitchPorts(): Promise<EthernetPort[]>

Overrides GenericSwitchConfigurator.getSwitchPorts
- Defined in src/connector/classwrapper/SwitchConfigurator.ts:57
Fetch all ports from the switch

Returns Promise<EthernetPort[]>
Switch ports

getVLAN

getVLAN(vid: number): Promise<null | VLAN>

Overrides GenericSwitchConfigurator.getVLAN
- Defined in src/connector/classwrapper/SwitchConfigurator.ts:121
Get specific VLAN using VID

Parameters
- vid: number
  
  VLAN ID
Returns Promise<null | VLAN>
VLAN or NULL if there is no VLAN available in given VID

init

init(): Promise<void>

Inherited from GenericSwitchConfigurator.init
- Defined in src/driver/generic/SwitchConfigurator.ts:9
Returns Promise<void>

loadConfig

loadConfig(): Promise<void>

- Defined in src/connector/classwrapper/SwitchConfigurator.ts:27
load config from device.

This method must called before doing anything.

Note that, calling this method will throw out current modification

Returns Promise<void>

setSwitchPort

setSwitchPort(port: EthernetPort, portIdx: number): Promise<void>

Overrides GenericSwitchConfigurator.setSwitchPort
- Defined in src/connector/classwrapper/SwitchConfigurator.ts:82
Configure specific switch port

Parameters
- port: EthernetPort
  
  Configured EthernetPort object
- portIdx: number
  
  Target port which EthernetPort configuration applied.
Returns Promise<void>

setVLAN

setVLAN(vlan: VLAN): Promise<void>

Overrides GenericSwitchConfigurator.setVLAN
- Defined in src/connector/classwrapper/SwitchConfigurator.ts:145
Set specific vlan using VLAN object

Parameters
- vlan: VLAN
  
  VLAN object want to modify/create
Returns Promise<void>

Generated using TypeDoc