Class SriovVF

Hierarchy

SriovVF

Index

Constructors

constructor

Properties

name

Methods

Constructors

constructor

new SriovVF(index: number): SriovVF

- Defined in @types/Gjs/NM-1.0.d.ts:29264
Creates a new #NMSriovVF object.

Parameters
- index: number
  
  the VF index
Returns SriovVF

Properties

Static name

name: string

Methods

add_vlan

add_vlan(vlan_id: number): boolean

- Defined in @types/Gjs/NM-1.0.d.ts:29182
Adds a VLAN to the VF. Currently kernel only supports one VLAN per VF.

Parameters
- vlan_id: number
  
  the VLAN id
Returns boolean

dup

dup(): SriovVF

- Defined in @types/Gjs/NM-1.0.d.ts:29186
Creates a copy of vf.

Returns SriovVF

equal

equal(other: SriovVF): boolean

- Defined in @types/Gjs/NM-1.0.d.ts:29192
Determines if two #NMSriovVF objects have the same index, attributes and VLANs.

Parameters
- other: SriovVF
  
  the #NMSriovVF to compare vf to.
Returns boolean

get_attribute

get_attribute(name: string): GLib.Variant

- Defined in @types/Gjs/NM-1.0.d.ts:29197
Gets the value of the attribute with name name on vf

Parameters
- name: string
  
  the name of a VF attribute
Returns GLib.Variant

get_attribute_names

get_attribute_names(): string[]

- Defined in @types/Gjs/NM-1.0.d.ts:29201
Gets an array of attribute names defined on vf.

Returns string[]

get_index

get_index(): number

- Defined in @types/Gjs/NM-1.0.d.ts:29205
Gets the index property of this VF object.

Returns number

get_vlan_ids

get_vlan_ids(): number[]

- Defined in @types/Gjs/NM-1.0.d.ts:29210
Returns the VLANs currently configured on the VF. Currently kernel only supports one VLAN per VF.

Returns number[]

get_vlan_protocol

get_vlan_protocol(vlan_id: number): SriovVFVlanProtocol

- Defined in @types/Gjs/NM-1.0.d.ts:29211
Parameters
- vlan_id: number
Returns SriovVFVlanProtocol

get_vlan_qos

get_vlan_qos(vlan_id: number): number

- Defined in @types/Gjs/NM-1.0.d.ts:29216
Returns the QoS value for the given VLAN.

Parameters
- vlan_id: number
  
  the VLAN id
Returns number

ref

ref(): void

- Defined in @types/Gjs/NM-1.0.d.ts:29220
Increases the reference count of the object.

Returns void

remove_vlan

remove_vlan(vlan_id: number): boolean

- Defined in @types/Gjs/NM-1.0.d.ts:29225
Removes a VLAN from a VF.

Parameters
- vlan_id: number
  
  the VLAN id
Returns boolean

set_attribute

set_attribute(name: string, value: GLib.Variant): void

- Defined in @types/Gjs/NM-1.0.d.ts:29231
Sets the named attribute on vf to the given value.

Parameters
- name: string
  
  the name of a route attribute
- value: GLib.Variant
  
  the value
Returns void

set_vlan_protocol

set_vlan_protocol(vlan_id: number, protocol: SriovVFVlanProtocol): void

- Defined in @types/Gjs/NM-1.0.d.ts:29237
Sets the protocol for the given VLAN.

Parameters
- vlan_id: number
  
  the VLAN id
- protocol: SriovVFVlanProtocol
  
  the VLAN protocol
Returns void

set_vlan_qos

set_vlan_qos(vlan_id: number, qos: number): void

- Defined in @types/Gjs/NM-1.0.d.ts:29243
Sets a QoS value for the given VLAN.

Parameters
- vlan_id: number
  
  the VLAN id
- qos: number
  
  a QoS (priority) value
Returns void

unref

unref(): void

- Defined in @types/Gjs/NM-1.0.d.ts:29248
Decreases the reference count of the object. If the reference count reaches zero, the object will be destroyed.

Returns void

Static attribute_validate

attribute_validate(name: string, value: GLib.Variant): [boolean, boolean]

- Defined in @types/Gjs/NM-1.0.d.ts:29277
Validates a VF attribute, i.e. checks that the attribute is a known one, the value is of the correct type and well-formed.

Parameters
- name: string
  
  the attribute name
- value: GLib.Variant
  
  the attribute value
Returns [boolean, boolean]

Static new

new(index: number): SriovVF

- Defined in @types/Gjs/NM-1.0.d.ts:29270
Creates a new #NMSriovVF object.

Parameters
- index: number
  
  the VF index
Returns SriovVF