# salt.modules.smartos_nictagadm

Module for running nictagadm command on SmartOS :maintainer: Jorge Schrauwen <sjorge@blackdot.be> :maturity: new :depends: nictagadm binary, dladm binary :platform: smartos

Added in version 2016.11.0.

salt.modules.smartos_nictagadm.add(name, mac, mtu=1500)

  Add a new nictag

  namestring

    name of new nictag

  macstring

    mac of parent interface or 'etherstub' to create a ether stub

  mtuint

    MTU (ignored for etherstubs)

  CLI Example:

      salt '*' nictagadm.add storage0 etherstub
      salt '*' nictagadm.add trunk0 'DE:AD:OO:OO:BE:EF' 9000

salt.modules.smartos_nictagadm.delete(name, force=False)

  Delete nictag

  namestring

    nictag to delete

  forceboolean

    force delete even if vms attached

  CLI Example:

      salt '*' nictagadm.exists admin

salt.modules.smartos_nictagadm.exists(*nictag, **kwargs)

  Check if nictags exists

  nictagstring

    one or more nictags to check

  verboseboolean

    return list of nictags

  CLI Example:

      salt '*' nictagadm.exists admin

salt.modules.smartos_nictagadm.list_nictags(include_etherstubs=True)

  List all nictags

  include_etherstubsboolean

    toggle include of etherstubs

  CLI Example:

      salt '*' nictagadm.list

salt.modules.smartos_nictagadm.update(name, mac=None, mtu=None)

  Update a nictag

  namestring

    name of nictag

  macstring

    optional new mac for nictag

  mtuint

    optional new MTU for nictag

  CLI Example:

      salt '*' nictagadm.update trunk mtu=9000

salt.modules.smartos_nictagadm.vms(nictag)

  List all vms connect to nictag

  nictagstring

    name of nictag

  CLI Example:

      salt '*' nictagadm.vms admin