ovirt_vnic_profile – Module to manage vNIC profile of network in oVirt/RHV — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ovirt_vnic_profile – Module to manage vNIC profile of network in oVirt/RHV

New in version 2.8.

- Synopsis

- Requirements

- Parameters

- Notes

- Examples

- Return Values

- Status

## Synopsis

- Module to manage vNIC profile of network in oVirt/RHV

## Requirements

The below requirements are needed on the host that executes this module.

- python >= 2.7

- ovirt-engine-sdk-python >= 4.3.0

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
auth dictionary / required |  | Dictionary with values needed to create HTTP/HTTPS connection to oVirt:
| ca_file string |  | A PEM file containing the trusted CA certificates. The certificate presented by the server will be verified using these CA certificates. If `ca_file` parameter is not set, system wide CA certificate store is used. Default value is set by `OVIRT_CAFILE` environment variable.
| headers dictionary |  | Dictionary of HTTP headers to be added to each API call.
| hostname string |  | A string containing the hostname of the server, usually something like `server.example.com`. Default value is set by `OVIRT_HOSTNAME` environment variable. Either `url` or `hostname` is required.
| insecure boolean | Choices: no yes | A boolean flag that indicates if the server TLS certificate and host name should be checked.
| kerberos boolean | Choices: no yes | A boolean flag indicating if Kerberos authentication should be used instead of the default basic authentication.
| password string / required |  | The password of the user. Default value is set by `OVIRT_PASSWORD` environment variable.
| token string |  | Token to be used instead of login with username/password. Default value is set by `OVIRT_TOKEN` environment variable.
| url string |  | A string containing the API URL of the server, usually something like `https://server.example.com/ovirt-engine/api`. Default value is set by `OVIRT_URL` environment variable. Either `url` or `hostname` is required.
| username string / required |  | The name of the user, something like admin@internal. Default value is set by `OVIRT_USERNAME` environment variable.
custom_properties - |  | Custom properties applied to the vNIC profile. Custom properties is a list of dictionary which can have following values:
| name - |  | Name of the custom property. For example: hugepages, vhost, sap_agent, etc.
| regexp - |  | Regular expression to set for custom property.
| value - |  | Value to set for custom property.
data_center - / required |  | Datacenter name where network reside.
description - |  | A human-readable description in plain text.
fetch_nested boolean | Choices: no yes | If True the module will fetch additional data from the API. It will fetch IDs of the VMs disks, snapshots, etc. User can configure to fetch other attributes of the nested entities by specifying `nested_attributes`.
migratable boolean | Choices: no yes | Marks whether pass_through NIC is migratable or not.
name - / required |  | A human-readable name in plain text.
nested_attributes list |  | Specifies list of the attributes which should be fetched from the API. This parameter apply only when `fetch_nested` is true.
network - / required |  | Name of network to which is vNIC attached.
network_filter - |  | The network filter enables to filter packets send to/from the VM's nic according to defined rules.
pass_through - | Choices: disabled enabled | Enables passthrough to an SR-IOV-enabled host NIC. When enabled `qos` and `network_filter` are automatically set to None and `port_mirroring` to False. When enabled and `migratable` not specified then `migratable` is enabled. Port mirroring, QoS and network filters are not supported on passthrough profiles.
poll_interval integer | Default: 3 | Number of the seconds the module waits until another poll request on entity status is sent.
port_mirroring boolean | Choices: no yes | Enables port mirroring.
qos - |  | Quality of Service attributes regulate inbound and outbound network traffic of the NIC.
state - | Choices: absent present ← | Should the vNIC be absent/present.
timeout integer | Default: 180 | The amount of time in seconds the module should wait for the instance to get into desired state.
wait boolean | Choices: no yes ← | `yes` if the module should wait for the entity to get into desired state.

## Notes

Note

- In order to use this module you have to install oVirt Python SDK. To ensure it’s installed with correct version you can create the following task: pip: name=ovirt-engine-sdk-python version=4.3.0

## Examples

    # Examples don't contain auth parameter for simplicity,
    # look at ovirt_auth module to see how to reuse authentication:
    - name: Add vNIC
      ovirt_vnic_profile:
        name: myvnic
        network: mynetwork
        state: present
        data_center: datacenter

    - name: Editing vNICs network_filter, custom_properties, qos
      ovirt_vnic_profile:
        name: myvnic
        network: mynetwork
        data_center: datacenter
        qos: myqos
        custom_properties:
          - name: SecurityGroups
            value: 9bd9bde9-39da-44a8-9541-aa39e1a81c9d
        network_filter: allow-dhcp

    - name: Remove vNICs network_filter, custom_properties, qos
      ovirt_vnic_profile:
        name: myvnic
        network: mynetwork
        data_center: datacenter
        qos: ""
        custom_properties: ""
        network_filter: ""

    - name: Dont use migratable
      ovirt_vnic_profile:
        name: myvnic
        network: mynetwork
        data_center: datacenter
        migratable: False
        pass_through: enabled

    - name: Remove vNIC
      ovirt_vnic_profile:
        name: myvnic
        network: mynetwork
        state: absent
        data_center: datacenter

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
id string | On success if vNIC profile is found. | ID of the vNIC profile which is managed Sample: 7de90f31-222c-436c-a1ca-7e655bd5b60c
vnic dictionary | On success if vNIC profile is found. | Dictionary of all the vNIC profile attributes. Network interface attributes can be found on your oVirt/RHV instance at following url: http://ovirt.github.io/ovirt-engine-api-model/master/#types/nic.

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]

- This module is maintained by the Ansible Community. [community]

### Authors

- Ondra Machacek (@machacekondra)

- Martin Necas (@mnecas)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.