W3cubDocs

/SaltStack

salt.modules.smartos_nictagadm module

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

..versionadded:: 2016.11.0

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

Add a new nictag

name : string
name of new nictag
mac : string
mac of parent interface or 'etherstub' to create a ether stub
mtu : int
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

name : string
nictag to delete
force : boolean
force delete even if vms attached

CLI Example:

salt '*' nictagadm.exists admin

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

Check if nictags exists

nictag : string
one or more nictags to check
verbose : boolean
return list of nictags

CLI Example:

salt '*' nictagadm.exists admin

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

List all nictags

include_etherstubs : boolean
toggle include of etherstubs

CLI Example:

salt '*' nictagadm.list

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

Update a nictag

name : string
name of nictag
mac : string
optional new mac for nictag
mtu : int
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

nictag : string
name of nictag

CLI Example:

salt '*' nictagadm.vms admin

© 2019 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.smartos_nictagadm.html