community.general.nictagadm (8.5.0) — module

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Create or delete nic tags on SmartOS systems.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Remove 'storage0' nic tag
  community.general.nictagadm:
    name: storage0
    state: absent

Inputs

    
mac:
    description:
    - Specifies the O(mac) address to attach the nic tag to when not creating an O(etherstub).
    - Parameters O(mac) and O(etherstub) are mutually exclusive.
    type: str

mtu:
    description:
    - Specifies the size of the O(mtu) of the desired nic tag.
    - Parameters O(mtu) and O(etherstub) are mutually exclusive.
    type: int

name:
    description:
    - Name of the nic tag.
    required: true
    type: str

force:
    default: false
    description:
    - When O(state=absent) this switch will use the C(-f) parameter and delete the nic
      tag regardless of existing VMs.
    type: bool

state:
    choices:
    - absent
    - present
    default: present
    description:
    - Create or delete a SmartOS nic tag.
    type: str

etherstub:
    default: false
    description:
    - Specifies that the nic tag will be attached to a created O(etherstub).
    - Parameter O(etherstub) is mutually exclusive with both O(mtu), and O(mac).
    type: bool

Outputs

etherstub:
  description: specifies if the nic tag will create and attach to an etherstub.
  returned: always
  sample: false
  type: bool
force:
  description: Shows if -f was used during the deletion of a nic tag
  returned: always
  sample: false
  type: bool
mac:
  description: MAC Address that the nic tag was attached to.
  returned: always
  sample: 00:1b:21:a3:f5:4d
  type: str
mtu:
  description: specifies which MTU size was passed during the nictagadm add command.
    mtu and etherstub are mutually exclusive.
  returned: always
  sample: 1500
  type: int
name:
  description: nic tag name
  returned: always
  sample: storage0
  type: str
state:
  description: state of the target
  returned: always
  sample: present
  type: str