community.general.nictagadm module – Manage nic tags on SmartOS systems
Note
This module is part of the community.general collection (version 9.5.1).
You might already have this collection installed if you are using the ansible
package.
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 community.general
.
To use it in a playbook, specify: community.general.nictagadm
.
Synopsis
Create or delete nic tags on SmartOS systems.
Parameters
Parameter |
Comments |
---|---|
When Choices:
|
|
Name of the nic tag. |
|
Create or delete a SmartOS nic tag. Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Create 'storage0' on '00:1b:21:a3:f5:4d'
community.general.nictagadm:
name: storage0
mac: 00:1b:21:a3:f5:4d
mtu: 9000
state: present
- name: Remove 'storage0' nic tag
community.general.nictagadm:
name: storage0
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
specifies if the nic tag will create and attach to an etherstub. Returned: always Sample: |
|
Shows if -f was used during the deletion of a nic tag Returned: always Sample: |
|
MAC Address that the nic tag was attached to. Returned: always Sample: |
|
specifies which MTU size was passed during the nictagadm add command. mtu and etherstub are mutually exclusive. Returned: always Sample: |
|
nic tag name Returned: always Sample: |
|
state of the target Returned: always Sample: |
Authors
Bruce Smith (@SmithX10)