scale_computing.hypercore.vm_nic_info module – Returns info about NIC

Note

This module is part of the scale_computing.hypercore collection (version 1.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install scale_computing.hypercore.

To use it in a playbook, specify: scale_computing.hypercore.vm_nic_info.

New in scale_computing.hypercore 1.0.0

Synopsis

  • Returns the information about all or a specific NIC on a selected virtual machine.

Parameters

Parameter

Comments

cluster_instance

dictionary

Scale Computing HyperCore instance information.

auth_method

string

Select login method. If not set, the value of the SC_AUTH_METHOD environment variable will be used.

Value local - username/password is verified by the HyperCore server (the local users).

Value oidc - username/password is verified by the configured OIDC provider.

Choices:

  • "local" ← (default)

  • "oidc"

host

string / required

The HyperCore instance URL.

If not set, the value of the SC_HOST environment variable will be used.

For example “https://10.1.2.3:443”.

password

string / required

Password used for authentication.

If not set, the value of the SC_PASSWORD environment variable will be used.

timeout

float

Timeout in seconds for the connection with the Scale Computing HyperCore API instance.

If not set, the value of the SC_TIMEOUT environment variable will be used.

username

string / required

Username used for authentication.

If not set, the value of the SC_USERNAME environment variable will be used.

vlan

integer

VLAN on which network interface is operating on.

Used to identify specific network interface.

If included only network interface with the specified VLAN will be returned.

vm_name

string / required

Virtual machine name.

Used to identify selected virtual machine by name.

Examples

- name: Retrieve NIC info on VLAN 15
  scale_computing.hypercore.vm_nic_info:
    vm_name: 'XLAB-demo-vm'
    vlan: 15
  register: testout

- name: Retrieve NIC info on all vlans
  scale_computing.hypercore.vm_nic_info:
    vm_name: 'XLAB-demo-vm'
  register: testout

Return Values

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

Key

Description

records

list / elements=dictionary

A list of NICs records.

Returned: success

connected

boolean

Enabled and can make connections

Returned: success

Sample: true

ipv4_addresses

list / elements=string

IPv4 addresses registered with this device

Returned: success

Sample: ["192.0.2.1"]

mac

string

MAC address of the virtual network device

Returned: success

Sample: "12-34-56-78-AB"

type

string

Virtualized network device types

Returned: success

Sample: "virtio"

uuid

string

Unique identifier

Returned: success

Sample: "07a2a68a-0afa-4718-9c6f-00a39d08b67e"

vlan

integer

VLAN tag of the interface

Returned: success

Sample: 15

Authors

  • Domen Dobnikar (@domen_dobnikar)