NM-1.0 ▶ NM ▶ SriovVF

constructor

• new SriovVF(index: number): SriovVF

  Parameters

  • index: number

  Returns SriovVF

Static$gtype

Since 1.14add_vlan

• add_vlan(vlan_id: number): boolean

  Adds a VLAN to the VF. Currently kernel only supports one VLAN per VF.

  Parameters

  • vlan_id: number

    the VLAN id

  Returns boolean

  true if the VLAN was added; false if it already existed

  Since

  1.14

Since 1.14dup

• dup(): SriovVF

  Creates a copy of vf.

  Returns SriovVF

  a copy of vf

  Since

  1.14

Since 1.14equal

• equal(other: SriovVF): boolean

  Determines if two NM.SriovVF objects have the same index, attributes and VLANs.

  Parameters

  • other: SriovVF

    the NM.SriovVF to compare vf to.

  Returns boolean

  true if the objects contain the same values, false if they do not.

  Since

  1.14

Since 1.14get_attribute

• get_attribute(name: string): GLib.Variant

  Gets the value of the attribute with name name on vf

  Parameters

  • name: string

    the name of a VF attribute

  Returns GLib.Variant

  the value of the attribute with name name on vf, or null if vf has no such attribute.

  Since

  1.14

Since 1.14get_attribute_names

• get_attribute_names(): string[]

  Gets an array of attribute names defined on vf.

  Returns string[]

  a null-terminated array of attribute names

  Since

  1.14

Since 1.14get_index

• get_index(): number

  Gets the index property of this VF object.

  Returns number

  the VF index

  Since

  1.14

Since 1.14get_vlan_ids

• get_vlan_ids(): number[]

  Returns the VLANs currently configured on the VF. Currently kernel only supports one VLAN per VF.

  Returns number[]

  a list of VLAN ids configured on the VF.

  Since

  1.14

Since 1.14get_vlan_protocol

• get_vlan_protocol(vlan_id: number): NM.SriovVFVlanProtocol

  Returns the configured protocol for the given VLAN.

  Parameters

  • vlan_id: number

    the VLAN id

  Returns NM.SriovVFVlanProtocol

  the configured protocol

  Since

  1.14

Since 1.14get_vlan_qos

• get_vlan_qos(vlan_id: number): number

  Returns the QoS value for the given VLAN.

  Parameters

  • vlan_id: number

    the VLAN id

  Returns number

  the QoS value

  Since

  1.14

Since 1.14ref

• ref(): void

  Increases the reference count of the object.

  Returns void

  Since

  1.14

Since 1.14remove_vlan

• remove_vlan(vlan_id: number): boolean

  Removes a VLAN from a VF.

  Parameters

  • vlan_id: number

    the VLAN id

  Returns boolean

  true if the VLAN was removed, false if the VLAN vlan_id did not belong to the VF.

  Since

  1.14

Since 1.14set_attribute

• set_attribute(name: string, value: GLib.Variant<any>): void

  Sets the named attribute on vf to the given value.

  Parameters

  • name: string

    the name of a route attribute

  • value: GLib.Variant<any>

    the value

  Returns void

  Since

  1.14

Since 1.14set_vlan_protocol

• set_vlan_protocol(vlan_id: number, protocol: NM.SriovVFVlanProtocol): void

  Sets the protocol for the given VLAN.

  Parameters

  • vlan_id: number

    the VLAN id

  • protocol: NM.SriovVFVlanProtocol

    the VLAN protocol

  Returns void

  Since

  1.14

Since 1.14set_vlan_qos

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

  Sets a QoS value for the given VLAN.

  Parameters

  • vlan_id: number

    the VLAN id

  • qos: number

    a QoS (priority) value

  Returns void

  Since

  1.14

Since 1.14unref

• unref(): void

  Decreases the reference count of the object. If the reference count reaches zero, the object will be destroyed.

  Returns void

  Since

  1.14

StaticSince 1.42attribute_validate

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

  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]

  Since

  1.42

Staticnew

• new(index: number): SriovVF

  Parameters

  • index: number

  Returns SriovVF