Data ONTAP® PowerShell Toolkit

Switch to Data ONTAP 7-mode documentation.

Cmdlet: Set-NcNetInterface


NAME
Set-NcNetInterface

SYNOPSIS
Modify the attributes of a network interface (LIF).

SYNTAX
Set-NcNetInterface [-Name] <String> [-Vserver] <String> [-Node <String>] [-P
ort <String>] [-Address <String>] [-Netmask <String>] [-Ipv4LinkLocal [<Bool
ean>]] [-RoutingGroup <String>] [-DnsDomain <String>] [-FirewallPolicy <Stri
ng>] [-FailoverPolicy <String>] [-FailoverGroup <String>] [-UseFailoverGroup
<String>] [-AutoRevert [<Boolean>]] [-AdministrativeStatus <String>] [-Comm
ent <String>] [-Controller <NcController[]>] [-WhatIf] [-Confirm] [<CommonPa
rameters>]


DESCRIPTION
Modify the attributes of a network interface (LIF).


PARAMETERS
-Name <String>
Specifies the logical interface (LIF) name.

Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Vserver <String>
Specifies the Vserver name.

Required? true
Position? 2
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Node <String>
Specifies the LIF's home node.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Port <String>
Specifies the LIF's home port.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Address <String>
Specifies the LIF's IP address. This element is valid for all data prot
ocols except FCP.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Netmask <String>
Specifies the LIF's netmask. This element is valid for all data protoco
ls except FCP.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Ipv4LinkLocal [<Boolean>]
If true, automatically configure an interface with an IPv4 address (clus
ter LIFs only). User can configure an interface by explicitly specifyin
g Address and Netmask or by setting Ipv4LinkLocal to true.

Required? false
Position? named
Default value false
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-RoutingGroup <String>
Specifies the routing group, which enables multiple logical interfaces t
o share a set of routing table entries. For example:

d192.168.1.0/24 ('d' stands for data LIF and 192.168.1.0/24 is subnet)
c192.168.1.0/24 ('c' stands for cluster LIF and 192.168.1.0/24 is subnet
)
n192.168.1.0/24 ('n' stands for node management LIF and 192.168.1.0/24 i
s subnet)

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-DnsDomain <String>
Specifies the unique, fully qualified domain name of the DNS zone of thi
s LIF.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-FirewallPolicy <String>
Specifies the firewall policy for the LIF. Default firewall policy is s
et as per the following table:

LIF Role Protocols Default policy
------- --------- --------------
data none mgmt
data any data
node_mgmt any mgmt
cluster_mgmt any mgmt
cluster any cluster
intercluster any intercluster

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-FailoverPolicy <String>
Specifies the failover policy for the LIF. For FCP and iSCSI LIFs, the
only failover policy is 'disabled'; for NFS, CIFs and fcache LIFs, the d
efault policy is 'nextavail'. Possible values:

"nextavail" - Next failover target selected based on next available port
ID
"priority" - Next failover target selected based on lowest available po
rt ID
"disabled" - Failover disabled

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-FailoverGroup <String>
Specifies the failover group name.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-UseFailoverGroup <String>
Specifies whether failover rules are automatically created, manually cre
ated by the administrator, or disabled. For FCP and iSCSI LIFs, the def
ault policy is 'disabled'; for NFS, CIFs and fcache LIFs, the default po
licy is 'system_defined'. Possible values:

"system_defined" - Use port roles to select failover targets
"disabled" - Failover disabled
"enabled" - Use a failover group to select failover targets

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-AutoRevert [<Boolean>]
If true, data LIF will revert to its home node under certain circumstanc
es such as startup, and load balancing migration capability is disabled
automatically.

Required? false
Position? named
Default value false
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-AdministrativeStatus <String>
Specifies the administrative status of the LIF. The administrative stat
us can differ from the operational status; for instance, if you specify
the status as up but a network problem prevents the interface from funct
ioning, the operational status remains as down. Possible values: 'up',
'down', 'unknown'

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Comment <String>
Comment to give the interface.

Required? false
Position? named
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false

-Controller <NcController[]>
A clustered Data ONTAP controller to receive this cmdlet, as embodied by
an NcController object. This parameter is returned by the Connect-NcCo
ntroller cmdlet. If not specified, the value in the global variable Cur
rentNcController is used. In the latter case, if CurrentNcController co
ntains a collection of NcController objects, this cmdlet is invoked on e
ach controller in succession.

Required? false
Position? named
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false

-WhatIf


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

-Confirm


Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer and OutVariable. For more information, type,
"get-help about_commonparameters".

INPUTS



OUTPUTS
DataONTAP.C.Types.Net.NetInterfaceInfo


NOTES


Category: net
API: net-interface-modify
Family: cluster

-------------- Example 1 --------------

C:\PS>Set-NcNetInterface vs1vif1 vserver1 -Address 10.61.172.162


Change the address on LIF 'vs1vif1'.


NcController : 10.61.172.155
Address : 10.61.172.162
AdministrativeStatus : down
CurrentNode : fas3070cluster01-01
CurrentPort : e0a
DataProtocols : {iscsi}
DnsDomainName : none
FailoverGroup :
FailoverPolicy : disabled
FirewallPolicy : data
HomeNode : fas3070cluster01-01
HomePort : e0a
InterfaceName : vs1vif1
IsAutoRevert : False
IsHome : True
IsIpv4LinkLocal :
Netmask : 255.255.255.0
NetmaskLength : 24
OperationalStatus : down
Role : data
RoutingGroupName : d10.61.172.0/24
UseFailoverGroup : disabled
Vserver : vserver1
IsAutoRevertSpecified : True
IsHomeSpecified : True
IsIpv4LinkLocalSpecified : False
NetmaskLengthSpecified : True
OpStatus : down



RELATED LINKS
Get-NcNetInterface
New-NcNetInterface
Remove-NcNetInterface
Update-NcNetInterface







 Data ONTAP® PowerShell Toolkit